ProfileRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

ProfileRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

createProfile(CreateProfileContext, boolean)	Membuat profil
deleteProfileAttribute(string, string)
getAvatar(string, string, string)
getAvatarPreview(any, string, string, string, string)
getProfile(string, boolean, boolean, string, string, boolean)	Mendapatkan profil pengguna.
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)	Memperbarui profil

Detail Konstruktor

ProfileRestClient(IVssRestClientOptions)

new ProfileRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createProfile(CreateProfileContext, boolean)

Membuat profil

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

Parameter

createProfileContext

CreateProfileContext

Konteks untuk pembuatan profil

autoCreate

boolean

Membuat profil secara otomatis

Mengembalikan

Promise<Profile>

deleteProfileAttribute(string, string)

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

Parameter

id

string

descriptor

string

Mengembalikan

Promise<void>

getAvatar(string, string, string)

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

Parameter

id

string

size

string

format

string

Mengembalikan

Promise<Avatar>

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

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

Parameter

container

any

id

string

size

string

format

string

displayName

string

Mengembalikan

Promise<Avatar>

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

Mendapatkan profil pengguna.

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

Parameter

id

string

ID profil pengguna target dalam organisasi yang sama, atau 'saya' untuk mendapatkan profil pengguna yang diautentikasi saat ini.

details

boolean

Mengembalikan informasi profil publik seperti nama tampilan, alamat email, negara, dll. Jika false, parameter withAttributes diabaikan.

withAttributes

boolean

Jika true, mendapatkan atribut (bernama pasangan kunci-nilai dari data arbitrer) yang terkait dengan profil. Parameter partisi juga harus memiliki nilai.

partition

string

Partisi (grup bernama) atribut yang akan dikembalikan.

coreAttributes

string

Daftar atribut profil inti yang dibatasi koma untuk dikembalikan. Nilai yang valid adalah Email, Avatar, DisplayName, dan ContactWithOffers.

forceRefresh

boolean

Tidak digunakan dalam versi API ini.

Mengembalikan

Promise<Profile>

getProfileAttribute(string, string)

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

Parameter

id

string

descriptor

string

Mengembalikan

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

Parameter

id

string

partition

string

modifiedSince

string

modifiedAfterRevision

string

withCoreAttributes

boolean

coreAttributes

string

Mengembalikan

Promise<ProfileAttribute[]>

resetAvatar(string)

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

Parameter

id

string

Mengembalikan

Promise<void>

setAvatar(any, string)

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

Parameter

container

any

id

string

Mengembalikan

Promise<void>

setProfileAttribute(any, string, string)

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

Parameter

container

any

id

string

descriptor

string

Mengembalikan

Promise<void>

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

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

Parameter

attributesCollection

VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>

id

string

Mengembalikan

Promise<void>

updateProfile(Profile, string)

Memperbarui profil

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

Parameter

profile

Profile

Memperbarui profil

id

string

ID Profil

Mengembalikan

Promise<void>