Class ServerProjectListFilter

Encapsulates filtering information for listing server projects.

Inheritance

Object

ServerProjectListFilter

Syntax

public class ServerProjectListFilter

Fields

Client

The client attribute of the project. If null, no filtering is applied.

Declaration

public string Client

Type

String

Domain

The domain attribute of the project. If null, no filtering is applied.

Declaration

public string Domain

Type

String

LastChangedBefore

The last change attribute of a project denotes the time when content or configuration changed in the project. Filtering for projects that have ca change BEFORE the specified time allows the caller to list inactive projects. If null (default), no filtering based on this attribute is applied.

Declaration

public DateTime? LastChangedBefore

Type

Nullable<DateTime>

NameOrDescription

Case-insensitive partial name or description to search for. If value is empty or null, no filtering based on name or description is applied.

Declaration

public string NameOrDescription

Type

String

Project

The project attribute of the project. If null, no filtering is applied.

Declaration

public string Project

Type

String

SourceLanguageCode

This parameter can be used to filter the list based on the SOURCE language of the server project. The three+(two) letter langusage code of the language is to be provided, such as fre, eng, eng-US. If a three letter language code is provided all three+two letter matches are returned (e.g. if eng is specified then server projects with source language eng-US, eng-gb, ... and eng are returned. If this parameter is null, no source language filtering is applied.

Declaration

public string SourceLanguageCode

Type

String

Subject

The subject attribute of the project. If null, no filtering is applied.

Declaration

public string Subject

Type

String

TargetLanguageCode

This parameter can be used to filter the list based on the TARGET languages of the server project. A project is included in the filtered list if its target languages contain the language identified by TargetLanguageCode. The three+(two) letter langusage code of the language is to be provided, such as fre, eng, eng-US. If a three letter language code is provided all three+two letter matches are returned (e.g. if eng is specified then server projects with source language eng-US, eng-gb, ... and eng are returned. If this parameter is null, no target language filtering is applied.

Declaration

public string TargetLanguageCode

Type

String

TimeClosed

The TimeClosed attribute of the project. Replaces former IsArchived. Only projects that were closed after (or at the same time) TimeClosed are returned (including unclosed projects!). Recommended usage:

• Set it to a distant future value (equal or greater than 1/1/2500) to list unclosed projects only. This is the tipical way of listing server projects.
• Set to a datetime value in the past to include projects closed (after the specified time). If set to a small datetime value (e.g 1/1/1900) all projects are returned. If you need the list of projects not including unclosed ones, then remove unclosed projects from the result set in your system (based on the TimeClosed attribute of the returned ServerProjectInfo objects). List server projects including closed ones only if you have a reason to do so, as the returned result set may be significantly larger in this case.

Declaration

public DateTime TimeClosed

Type

DateTime