IVssIdentityService interface

パッケージ:

azure-devops-extension-api

メソッド

addMruIdentitiesAsync(IIdentity[])	MRU に ID の一覧を追加する
getConnections(IIdentity, boolean)	特定の ID の接続の一覧を取得します
getIdentityMruAsync()	最近使用した (MRU) ID の一覧を取得する
removeMruIdentitiesAsync(IIdentity[])	MRU から ID の一覧を削除する
searchIdentitiesAsync(string, string[], string[], string, any, (returnedEntities: IIdentity[]) => IIdentity[])	検索要求モデルが指定された場合は、エンティティの一覧を返します。 filterIdentity コールバックが追加された場合は、戻る前に値をさらにフィルター処理します

メソッドの詳細

addMruIdentitiesAsync(IIdentity[])

MRU に ID の一覧を追加する

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

パラメーター

identities

IIdentity[]

MRU に追加する IdentityRefs の一覧

戻り値

Promise<boolean>

項目が追加された場合は True、それ以外の場合は false

getConnections(IIdentity, boolean)

特定の ID の接続の一覧を取得します

function getConnections(identity: IIdentity, getDirectReports?: boolean): Promise<IdentitiesGetConnectionsResponseModel>

パラメーター

identity

IIdentity

接続を検索するエンティティ

getDirectReports

boolean

戻り値

Promise<IdentitiesGetConnectionsResponseModel>

特定の ID の接続

getIdentityMruAsync()

最近使用した (MRU) ID の一覧を取得する

function getIdentityMruAsync(): Promise<IIdentity[]>

戻り値

Promise<IIdentity[]>

最近使用された (MRU) ID の一覧

removeMruIdentitiesAsync(IIdentity[])

MRU から ID の一覧を削除する

function removeMruIdentitiesAsync(identity: IIdentity[]): Promise<boolean>

パラメーター

identity

IIdentity[]

戻り値

Promise<boolean>

アイテムが削除された場合は True、それ以外の場合は false

searchIdentitiesAsync(string, string[], string[], string, any, (returnedEntities: IIdentity[]) => IIdentity[])

検索要求モデルが指定された場合は、エンティティの一覧を返します。 filterIdentity コールバックが追加された場合は、戻る前に値をさらにフィルター処理します

function searchIdentitiesAsync(query: string, identityTypes?: string[], operationScopes?: string[], queryTypeHint?: string, options?: any, filterIdentity?: (returnedEntities: IIdentity[]) => IIdentity[]): Promise<IIdentity[]>

パラメーター

query

string

ID の種類を検索するクエリ。

identityTypes

string[]

検索する ID の種類 (既定の "user" と "group")

operationScopes

string[]

検索するスコープ (既定の "ims"、"source")

queryTypeHint

string

クエリが検索しようとしているプロパティのヒント

options

any

検索に渡す追加のオプション

filterIdentity

(returnedEntities: IIdentity[]) => IIdentity[]

見つかった ID の結果を変更するために渡されたフィルター

戻り値

Promise<IIdentity[]>

検索でフィルター処理された ID の一覧。