다음을 통해 공유

ProfileRestClient class

  • 참조
패키지:
azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends
RestClientBase

생성자

ProfileRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

createProfile(CreateProfileContext, boolean)

프로필 만들기
deleteProfileAttribute(string, string)
getAvatar(string, string, string)
getAvatarPreview(any, string, string, string, string)
getProfile(string, boolean, boolean, string, string, boolean)

사용자 프로필을 가져옵니다.
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)

프로필 업데이트

생성자 세부 정보

ProfileRestClient(IVssRestClientOptions) 

new ProfileRestClient(options: IVssRestClientOptions)

매개 변수

options
IVssRestClientOptions

속성 세부 정보

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

속성 값

string

메서드 세부 정보

createProfile(CreateProfileContext, boolean)

프로필 만들기

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

매개 변수

createProfileContext
CreateProfileContext

프로필 만들기에 대한 컨텍스트

autoCreate

boolean

자동으로 프로필 만들기

반환

Promise<Profile>

deleteProfileAttribute(string, string) 

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

매개 변수

id

string

descriptor

string

반환

Promise<void>

getAvatar(string, string, string) 

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

매개 변수

id

string

size

string

format

string

반환

Promise<Avatar>

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

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

매개 변수

container

any

id

string

size

string

format

string

displayName

string

반환

Promise<Avatar>

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

사용자 프로필을 가져옵니다.

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

매개 변수

id

string

동일한 organization 내의 대상 사용자 프로필 ID 또는 현재 인증된 사용자의 프로필을 가져오는 'me'입니다.

details

boolean

표시 이름, 전자 메일 주소, 국가 등과 같은 공개 프로필 정보를 반환합니다. false이면 withAttributes 매개 변수가 무시됩니다.

withAttributes

boolean

true이면 프로필과 연결된 특성(임의 데이터의 명명된 키-값 쌍)을 가져옵니다. 파티션 매개 변수에도 값이 있어야 합니다.

partition

string

반환할 특성의 파티션(명명된 그룹)입니다.

coreAttributes

string

반환할 핵심 프로필 특성의 쉼표로 구분된 목록입니다. 유효한 값은 Email, 아바타, DisplayName 및 ContactWithOffers입니다.

forceRefresh

boolean

이 버전의 API에서는 사용되지 않습니다.

반환

Promise<Profile>

getProfileAttribute(string, string) 

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

매개 변수

id

string

descriptor

string

반환

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

매개 변수

id

string

partition

string

modifiedSince

string

modifiedAfterRevision

string

withCoreAttributes

boolean

coreAttributes

string

반환

Promise<ProfileAttribute[]>

resetAvatar(string) 

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

매개 변수

id

string

반환

Promise<void>

setAvatar(any, string) 

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

매개 변수

container

any

id

string

반환

Promise<void>

setProfileAttribute(any, string, string) 

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

매개 변수

container

any

id

string

descriptor

string

반환

Promise<void>

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

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

매개 변수

attributesCollection

VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>

id

string

반환

Promise<void>

updateProfile(Profile, string)

프로필 업데이트

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

매개 변수

profile
Profile

프로필 업데이트

id

string

프로필 ID

반환

Promise<void>