Interface ChangeListSearchCriteria

Criteria used in a search for change lists

interface ChangeListSearchCriteria {
    compareVersion?: string;
    excludeDeletes?: boolean;
    followRenames?: boolean;
    fromDate?: string;
    fromVersion?: string;
    itemPath?: string;
    itemPaths?: string[];
    itemVersion?: string;
    skip?: number;
    toDate?: string;
    top?: number;
    toVersion?: string;
    user?: string;
}

Properties

compareVersion? excludeDeletes? followRenames? fromDate? fromVersion? itemPath? itemPaths? itemVersion? skip? toDate? top? toVersion? user?

Properties

OptionalcompareVersion

compareVersion?: string

If provided, a version descriptor to compare against base

OptionalexcludeDeletes

excludeDeletes?: boolean

If true, don't include delete history entries

OptionalfollowRenames

followRenames?: boolean

Whether or not to follow renames for the given item being queried

OptionalfromDate

fromDate?: string

If provided, only include history entries created after this date (string)

OptionalfromVersion

fromVersion?: string

If provided, a version descriptor for the earliest change list to include

OptionalitemPath

itemPath?: string

Path of item to search under. If the itemPaths memebr is used then it will take precedence over this.

OptionalitemPaths

itemPaths?: string[]

List of item paths to search under. If this member is used then itemPath will be ignored.

OptionalitemVersion

itemVersion?: string

Version of the items to search

Optionalskip

skip?: number

Number of results to skip (used when clicking more...)

OptionaltoDate

toDate?: string

If provided, only include history entries created before this date (string)

Optionaltop

top?: number

If provided, the maximum number of history entries to return

OptionaltoVersion

toVersion?: string

If provided, a version descriptor for the latest change list to include

Optionaluser

user?: string

Alias or display name of user who made the changes

Settings

Member Visibility

On This Page

Properties