Sdílet prostřednictvím

ProfileRestClient class

  • Reference
Balíček:
azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends
RestClientBase

Konstruktory

ProfileRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createProfile(CreateProfileContext, boolean)

Vytvořit profil
deleteProfileAttribute(string, string)
getAvatar(string, string, string)
getAvatarPreview(any, string, string, string, string)
getProfile(string, boolean, boolean, string, string, boolean)

Získá profil uživatele.
getProfileAttribute(string, string)
getProfileAttributes(string, string, string, string, boolean, string)
resetAvatar(string)
setAvatar(any, string)
setProfileAttribute(any, string, string)
setProfileAttributes(VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>, string)
updateProfile(Profile, string)

Aktualizovat profil

Podrobnosti konstruktoru

ProfileRestClient(IVssRestClientOptions) 

new ProfileRestClient(options: IVssRestClientOptions)

Parametry

options
IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createProfile(CreateProfileContext, boolean)

Vytvořit profil

function createProfile(createProfileContext: CreateProfileContext, autoCreate?: boolean): Promise<Profile>

Parametry

createProfileContext
CreateProfileContext

Kontext pro vytvoření profilu

autoCreate

boolean

Automatické vytvoření profilu

Návraty

Promise<Profile>

deleteProfileAttribute(string, string) 

function deleteProfileAttribute(id: string, descriptor: string): Promise<void>

Parametry

id

string

descriptor

string

Návraty

Promise<void>

getAvatar(string, string, string) 

function getAvatar(id: string, size?: string, format?: string): Promise<Avatar>

Parametry

id

string

size

string

format

string

Návraty

Promise<Avatar>

getAvatarPreview(any, string, string, string, string) 

function getAvatarPreview(container: any, id: string, size?: string, format?: string, displayName?: string): Promise<Avatar>

Parametry

container

any

id

string

size

string

format

string

displayName

string

Návraty

Promise<Avatar>

getProfile(string, boolean, boolean, string, string, boolean)

Získá profil uživatele.

function getProfile(id: string, details?: boolean, withAttributes?: boolean, partition?: string, coreAttributes?: string, forceRefresh?: boolean): Promise<Profile>

Parametry

id

string

ID cílového profilu uživatele ve stejné organizaci nebo "já" pro získání profilu aktuálního ověřeného uživatele.

details

boolean

Vrátit informace veřejného profilu, jako je zobrazované jméno, e-mailová adresa, země atd. Pokud je false, parametr withAttributes se ignoruje.

withAttributes

boolean

Pokud je true, získá atributy (pojmenované páry klíč-hodnota libovolných dat) přidružené k profilu. Parametr oddílu musí mít také hodnotu.

partition

string

Oddíl (pojmenovaná skupina) atributů, které se mají vrátit.

coreAttributes

string

Seznam atributů základního profilu oddělených čárkami, které se mají vrátit. Platné hodnoty jsou Email, Avatar, DisplayName a ContactWithOffers.

forceRefresh

boolean

V této verzi rozhraní API se nepoužívá.

Návraty

Promise<Profile>

getProfileAttribute(string, string) 

function getProfileAttribute(id: string, descriptor: string): Promise<ProfileAttribute>

Parametry

id

string

descriptor

string

Návraty

Promise<ProfileAttribute>

getProfileAttributes(string, string, string, string, boolean, string) 

function getProfileAttributes(id: string, partition: string, modifiedSince?: string, modifiedAfterRevision?: string, withCoreAttributes?: boolean, coreAttributes?: string): Promise<ProfileAttribute[]>

Parametry

id

string

partition

string

modifiedSince

string

modifiedAfterRevision

string

withCoreAttributes

boolean

coreAttributes

string

Návraty

Promise<ProfileAttribute[]>

resetAvatar(string) 

function resetAvatar(id: string): Promise<void>

Parametry

id

string

Návraty

Promise<void>

setAvatar(any, string) 

function setAvatar(container: any, id: string): Promise<void>

Parametry

container

any

id

string

Návraty

Promise<void>

setProfileAttribute(any, string, string) 

function setProfileAttribute(container: any, id: string, descriptor: string): Promise<void>

Parametry

container

any

id

string

descriptor

string

Návraty

Promise<void>

setProfileAttributes(VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>, string) 

function setProfileAttributes(attributesCollection: VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>, id: string): Promise<void>

Parametry

attributesCollection

VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>

id

string

Návraty

Promise<void>

updateProfile(Profile, string)

Aktualizovat profil

function updateProfile(profile: Profile, id: string): Promise<void>

Parametry

profile
Profile

Aktualizovat profil

id

string

ID profilu

Návraty

Promise<void>