ChangeListSearchCriteria interface

Package:

azure-devops-extension-api

Criteria used in a search for change lists

Properties

compareVersion	If provided, a version descriptor to compare against base
excludeDeletes	If true, don't include delete history entries
followRenames	Whether or not to follow renames for the given item being queried
fromDate	If provided, only include history entries created after this date (string)
fromVersion	If provided, a version descriptor for the earliest change list to include
itemPath	Path of item to search under. If the itemPaths memebr is used then it will take precedence over this.
itemPaths	List of item paths to search under. If this member is used then itemPath will be ignored.
itemVersion	Version of the items to search
skip	Number of results to skip (used when clicking more...)
toDate	If provided, only include history entries created before this date (string)
top	If provided, the maximum number of history entries to return
toVersion	If provided, a version descriptor for the latest change list to include
user	Alias or display name of user who made the changes

Property Details

compareVersion

If provided, a version descriptor to compare against base

compareVersion: string

Property Value

string

excludeDeletes

If true, don't include delete history entries

excludeDeletes: boolean

Property Value

boolean

followRenames

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

followRenames: boolean

Property Value

boolean

fromDate

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

fromDate: string

Property Value

string

fromVersion

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

fromVersion: string

Property Value

string

itemPath

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

itemPath: string

Property Value

string

itemPaths

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

itemPaths: string[]

Property Value

string[]

itemVersion

Version of the items to search

itemVersion: string

Property Value

string

skip

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

skip: number

Property Value

number

toDate

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

toDate: string

Property Value

string

top

If provided, the maximum number of history entries to return

top: number

Property Value

number

toVersion

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

toVersion: string

Property Value

string

user

Alias or display name of user who made the changes

user: string

Property Value

string