IPeoplePickerProvider interface

Package:

azure-devops-extension-api

Properties

addIdentitiesToMRU	Add identities to the MRU
getEntityFromUniqueAttribute	Request Entity information given an entityId
onEmptyInputFocus	If no input is in the search box when clicked, provide a set of identities to show (used for MRU)
onFilterIdentities	Given a list of currently selected items and a filter string, return a list of suggestions to put in the suggestion list
onRequestConnectionInformation	Request connection information about a given Entity.
removeIdentitiesFromMRU	Remove identities from the MRU

Property Details

addIdentitiesToMRU

Add identities to the MRU

addIdentitiesToMRU?: (identities: IIdentity[]) => Promise<boolean>

Property Value

(identities: IIdentity[]) => Promise<boolean>

getEntityFromUniqueAttribute

Request Entity information given an entityId

getEntityFromUniqueAttribute: (entityId: string) => IIdentity | PromiseLike<IIdentity>

Property Value

(entityId: string) => IIdentity | PromiseLike<IIdentity>

onEmptyInputFocus

If no input is in the search box when clicked, provide a set of identities to show (used for MRU)

onEmptyInputFocus?: () => null | IIdentity[] | PromiseLike<IIdentity[]>

Property Value

() => null | IIdentity[] | PromiseLike<IIdentity[]>

onFilterIdentities

Given a list of currently selected items and a filter string, return a list of suggestions to put in the suggestion list

onFilterIdentities: (filter: string, selectedItems?: IIdentity[]) => null | IIdentity[] | PromiseLike<IIdentity[]>

Property Value

(filter: string, selectedItems?: IIdentity[]) => null | IIdentity[] | PromiseLike<IIdentity[]>

onRequestConnectionInformation

Request connection information about a given Entity.

onRequestConnectionInformation: (entity: IIdentity, getDirectReports?: boolean) => IdentitiesGetConnectionsResponseModel | PromiseLike<IdentitiesGetConnectionsResponseModel>

Property Value

(entity: IIdentity, getDirectReports?: boolean) => IdentitiesGetConnectionsResponseModel | PromiseLike<IdentitiesGetConnectionsResponseModel>

removeIdentitiesFromMRU

Remove identities from the MRU

removeIdentitiesFromMRU?: (identities: IIdentity[]) => Promise<boolean>

Property Value

(identities: IIdentity[]) => Promise<boolean>