Delen via

ProfileRestClient class

  • Referentie
Pakket:
azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends
RestClientBase

Constructors

ProfileRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createProfile(CreateProfileContext, boolean)

Profiel maken
deleteProfileAttribute(string, string)
getAvatar(string, string, string)
getAvatarPreview(any, string, string, string, string)
getProfile(string, boolean, boolean, string, string, boolean)

Hiermee haalt u een gebruikersprofiel op.
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)

Profiel bijwerken

Constructordetails

ProfileRestClient(IVssRestClientOptions) 

new ProfileRestClient(options: IVssRestClientOptions)

Parameters

options
IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

createProfile(CreateProfileContext, boolean)

Profiel maken

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

Parameters

createProfileContext
CreateProfileContext

Context voor het maken van een profiel

autoCreate

boolean

Profiel automatisch maken

Retouren

Promise<Profile>

deleteProfileAttribute(string, string) 

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

Parameters

id

string

descriptor

string

Retouren

Promise<void>

getAvatar(string, string, string) 

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

Parameters

id

string

size

string

format

string

Retouren

Promise<Avatar>

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

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

Parameters

container

any

id

string

size

string

format

string

displayName

string

Retouren

Promise<Avatar>

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

Hiermee haalt u een gebruikersprofiel op.

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

Parameters

id

string

De id van het doelgebruikersprofiel binnen dezelfde organisatie of 'ik' om het profiel van de huidige geverifieerde gebruiker op te halen.

details

boolean

Openbare profielgegevens retourneren, zoals weergavenaam, e-mailadres, land, enzovoort. Als onwaar is, wordt de parameter withAttributes genegeerd.

withAttributes

boolean

Als dit waar is, worden de kenmerken (sleutel-waardeparen met willekeurige gegevens) die aan het profiel zijn gekoppeld, opgehaald. De partitieparameter moet ook een waarde hebben.

partition

string

De partitie (benoemde groep) kenmerken die moeten worden geretourneerd.

coreAttributes

string

Een door komma's gescheiden lijst met kernprofielkenmerken die moeten worden geretourneerd. Geldige waarden zijn Email, Avatar, DisplayName en ContactWithOffers.

forceRefresh

boolean

Niet gebruikt in deze versie van de API.

Retouren

Promise<Profile>

getProfileAttribute(string, string) 

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

Parameters

id

string

descriptor

string

Retouren

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

Parameters

id

string

partition

string

modifiedSince

string

modifiedAfterRevision

string

withCoreAttributes

boolean

coreAttributes

string

Retouren

Promise<ProfileAttribute[]>

resetAvatar(string) 

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

Parameters

id

string

Retouren

Promise<void>

setAvatar(any, string) 

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

Parameters

container

any

id

string

Retouren

Promise<void>

setProfileAttribute(any, string, string) 

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

Parameters

container

any

id

string

descriptor

string

Retouren

Promise<void>

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

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

Parameters

attributesCollection

VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>

id

string

Retouren

Promise<void>

updateProfile(Profile, string)

Profiel bijwerken

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

Parameters

profile
Profile

Profiel bijwerken

id

string

Profiel-id

Retouren

Promise<void>