ProfileRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
プロパティ
| RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
ProfileRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringプロパティ値
string
メソッドの詳細
createProfile(CreateProfileContext, boolean)
Create profile
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 パラメーターにも 値が必要です。
- 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
- id
-
string
返品
Promise<void>
updateProfile(Profile, string)
プロファイルの更新
function updateProfile(profile: Profile, id: string): Promise<void>パラメーター
- profile
- Profile
プロファイルの更新
- id
-
string
プロファイル ID
返品
Promise<void>