PeoplePickerProvider class

Package:

azure-devops-extension-api

Methods

addIdentitiesToMRU(IIdentity[])	Add identities to the MRU
getEntityFromUniqueAttribute(string)	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(string, IIdentity[])	Given a list of currently selected items and a filter string, return a list of suggestions to put in the suggestion list
onRequestConnectionInformation(IIdentity, boolean)	Request connection information about a given Entity.
removeIdentitiesFromMRU(IIdentity[])	Remove identities from the MRU

Method Details

addIdentitiesToMRU(IIdentity[])

Add identities to the MRU

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

Parameters

identities

IIdentity[]

Returns

Promise<boolean>

A promise that returns true if successful false otherwise

getEntityFromUniqueAttribute(string)

Request Entity information given an entityId

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

Parameters

entityId

string

Returns

IIdentity | PromiseLike<IIdentity>

onEmptyInputFocus()

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

function onEmptyInputFocus(): IIdentity[] | PromiseLike<IIdentity[]>

Returns

IIdentity[] | PromiseLike<IIdentity[]>

onFilterIdentities(string, IIdentity[])

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

function onFilterIdentities(filter: string, selectedItems?: IIdentity[]): IIdentity[] | Promise<IIdentity[]>

Parameters

filter

string

selectedItems

IIdentity[]

Returns

IIdentity[] | Promise<IIdentity[]>

onRequestConnectionInformation(IIdentity, boolean)

Request connection information about a given Entity.

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

Parameters

entity

IIdentity

getDirectReports

boolean

Returns

IdentitiesGetConnectionsResponseModel | PromiseLike<IdentitiesGetConnectionsResponseModel>

removeIdentitiesFromMRU(IIdentity[])

Remove identities from the MRU

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

Parameters

identities

IIdentity[]

Returns

Promise<boolean>

A promise that returns true if successful false otherwise