ProfileRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
| Profile |
Özellikler
| RESOURCE_AREA_ID |
Yöntemler
Oluşturucu Ayrıntıları
ProfileRestClient(IVssRestClientOptions)
Özellik Ayrıntıları
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: "8ccfef3d-2b87-4e99-8ccb-66e343d2daa8" = "8ccfef3d-2b87-4e99-8ccb-66e343d2daa8"Özellik Değeri
"8ccfef3d-2b87-4e99-8ccb-66e343d2daa8"
Yöntem Ayrıntıları
createProfile(CreateProfileContext, boolean)
Profil oluşturma
function createProfile(createProfileContext: CreateProfileContext, autoCreate?: boolean): Promise<Profile>Parametreler
- createProfileContext
- CreateProfileContext
Profil oluşturma bağlamı
- autoCreate
-
boolean
Profili otomatik olarak oluşturma
Döndürülenler
Promise<Profile>
deleteProfileAttribute(string, string)
function deleteProfileAttribute(id: string, descriptor: string): Promise<void>Parametreler
- id
-
string
- descriptor
-
string
Döndürülenler
Promise<void>
getAvatar(string, string, string)
function getAvatar(id: string, size?: string, format?: string): Promise<Avatar>Parametreler
- id
-
string
- size
-
string
- format
-
string
Döndürülenler
Promise<Avatar>
getAvatarPreview(any, string, string, string, string)
function getAvatarPreview(container: any, id: string, size?: string, format?: string, displayName?: string): Promise<Avatar>Parametreler
- container
-
any
- id
-
string
- size
-
string
- format
-
string
- displayName
-
string
Döndürülenler
Promise<Avatar>
getProfile(string, boolean, boolean, string, string, boolean)
Bir kullanıcı profili alır.
function getProfile(id: string, details?: boolean, withAttributes?: boolean, partition?: string, coreAttributes?: string, forceRefresh?: boolean): Promise<Profile>Parametreler
- id
-
string
Aynı kuruluştaki hedef kullanıcı profilinin kimliği veya geçerli kimliği doğrulanmış kullanıcının profilini almak için 'ben'.
- details
-
boolean
Görünen ad, e-posta adresi, ülke gibi genel profil bilgilerini iade edin. False ise, withAttributes parametresi yoksayılır.
- withAttributes
-
boolean
True ise, profille ilişkili öznitelikleri (rastgele verilerin anahtar-değer çiftleri olarak adlandırılır) alır. Bölüm parametresinin de bir değeri olmalıdır.
- partition
-
string
Döndürülecek özniteliklerin bölümü (adlandırılmış grup).
- coreAttributes
-
string
Döndürülecek çekirdek profil özniteliklerinin virgülle ayrılmış listesi. Geçerli değerler E-posta, Avatar, DisplayName ve ContactWithOffers'tır.
- forceRefresh
-
boolean
API'nin bu sürümünde kullanılmaz.
Döndürülenler
Promise<Profile>
getProfileAttribute(string, string)
function getProfileAttribute(id: string, descriptor: string): Promise<ProfileAttribute>Parametreler
- id
-
string
- descriptor
-
string
Döndürülenler
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[]>Parametreler
- id
-
string
- partition
-
string
- modifiedSince
-
string
- modifiedAfterRevision
-
string
- withCoreAttributes
-
boolean
- coreAttributes
-
string
Döndürülenler
Promise<ProfileAttribute[]>
resetAvatar(string)
function resetAvatar(id: string): Promise<void>Parametreler
- id
-
string
Döndürülenler
Promise<void>
setAvatar(any, string)
function setAvatar(container: any, id: string): Promise<void>Parametreler
- container
-
any
- id
-
string
Döndürülenler
Promise<void>
setProfileAttribute(any, string, string)
function setProfileAttribute(container: any, id: string, descriptor: string): Promise<void>Parametreler
- container
-
any
- id
-
string
- descriptor
-
string
Döndürülenler
Promise<void>
setProfileAttributes(VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>, string)
function setProfileAttributes(attributesCollection: VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>, id: string): Promise<void>Parametreler
- attributesCollection
- id
-
string
Döndürülenler
Promise<void>
updateProfile(Profile, string)
Profili güncelleştirme
function updateProfile(profile: Profile, id: string): Promise<void>Parametreler
- profile
- Profile
Profili güncelleştirme
- id
-
string
Profil Kimliği
Döndürülenler
Promise<void>