Condividi tramite

ProfileRestClient class

  • Riferimento
Pacchetto:
azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends
RestClientBase

Costruttori

ProfileRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

createProfile(CreateProfileContext, boolean)

Creare il profilo
deleteProfileAttribute(string, string)
getAvatar(string, string, string)
getAvatarPreview(any, string, string, string, string)
getProfile(string, boolean, boolean, string, string, boolean)

Ottiene un profilo utente.
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)

Update profile (Aggiorna profilo)

Dettagli costruttore

ProfileRestClient(IVssRestClientOptions) 

new ProfileRestClient(options: IVssRestClientOptions)

Parametri

options
IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

createProfile(CreateProfileContext, boolean)

Creare il profilo

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

Parametri

createProfileContext
CreateProfileContext

Contesto per la creazione del profilo

autoCreate

boolean

Creare automaticamente il profilo

Restituisce

Promise<Profile>

deleteProfileAttribute(string, string) 

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

Parametri

id

string

descriptor

string

Restituisce

Promise<void>

getAvatar(string, string, string) 

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

Parametri

id

string

size

string

format

string

Restituisce

Promise<Avatar>

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

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

Parametri

container

any

id

string

size

string

format

string

displayName

string

Restituisce

Promise<Avatar>

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

Ottiene un profilo utente.

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

Parametri

id

string

ID del profilo utente di destinazione all'interno della stessa organizzazione o "me" per ottenere il profilo dell'utente autenticato corrente.

details

boolean

Restituisce informazioni sul profilo pubblico, ad esempio nome visualizzato, indirizzo di posta elettronica, paese e così via. Se false, il parametro withAttributes viene ignorato.

withAttributes

boolean

Se true, ottiene gli attributi (coppie chiave-valore denominate di dati arbitrari) associati al profilo. Anche il parametro di partizione deve avere un valore.

partition

string

Partizione (gruppo denominato) di attributi da restituire.

coreAttributes

string

Elenco delimitato da virgole di attributi del profilo di base da restituire. I valori validi sono Email, Avatar, DisplayName e ContactWithOffers.

forceRefresh

boolean

Non usato in questa versione dell'API.

Restituisce

Promise<Profile>

getProfileAttribute(string, string) 

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

Parametri

id

string

descriptor

string

Restituisce

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[]>

Parametri

id

string

partition

string

modifiedSince

string

modifiedAfterRevision

string

withCoreAttributes

boolean

coreAttributes

string

Restituisce

Promise<ProfileAttribute[]>

resetAvatar(string) 

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

Parametri

id

string

Restituisce

Promise<void>

setAvatar(any, string) 

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

Parametri

container

any

id

string

Restituisce

Promise<void>

setProfileAttribute(any, string, string) 

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

Parametri

container

any

id

string

descriptor

string

Restituisce

Promise<void>

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

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

Parametri

attributesCollection

VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>

id

string

Restituisce

Promise<void>

updateProfile(Profile, string)

Update profile (Aggiorna profilo)

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

Parametri

profile
Profile

Update profile (Aggiorna profilo)

id

string

ID profilo

Restituisce

Promise<void>