Class ProfileApi

Hierarchy (View Summary)

ClientApiBase
- ProfileApi

Implements

IProfileApi

Constructors

constructor

new ProfileApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): ProfileApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns ProfileApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:43

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IProfileApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createProfile

createProfile(
createProfileContext: CreateProfileContext,
autoCreate?: boolean,
): Promise<Profile>
Create profile
Parameters
- createProfileContext: CreateProfileContext
  Context for profile creation
- OptionalautoCreate: boolean
  Create profile automatically
Returns Promise<Profile>
Implementation of IProfileApi.createProfile
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:510

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IProfileApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

deleteProfileAttribute

deleteProfileAttribute(id: string, descriptor: string): Promise<void>
Parameters
- id: string
- descriptor: string
Returns Promise<void>
Implementation of IProfileApi.deleteProfileAttribute
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:51

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IProfileApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getAvatar

getAvatar(id: string, size?: string, format?: string): Promise<Avatar>
Parameters
- id: string
- Optionalsize: string
- Optionalformat: string
Returns Promise<Avatar>
Implementation of IProfileApi.getAvatar
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:286

getAvatarPreview

getAvatarPreview(
    container: any,
    id: string,
    size?: string,
    format?: string,
    displayName?: string,
): Promise<Avatar>
Parameters
- container: any
- id: string
- Optionalsize: string
- Optionalformat: string
- OptionaldisplayName: string
Returns Promise<Avatar>
Implementation of IProfileApi.getAvatarPreview
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:336

getGeoRegion

getGeoRegion(ipaddress: string): Promise<GeoRegion>
Lookup up country/region based on provided IPv4, null if using the remote IPv4 address.
Parameters
- ipaddress: string
  IPv4 address to be used for reverse lookup, null if using RemoteIPAddress in request context
Returns Promise<GeoRegion>
Implementation of IProfileApi.getGeoRegion
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:465

getProfile

getProfile(
    id: string,
    details?: boolean,
    withAttributes?: boolean,
    partition?: string,
    coreAttributes?: string,
    forceRefresh?: boolean,
): Promise<Profile>
Parameters
- id: string
- Optionaldetails: boolean
- OptionalwithAttributes: boolean
- Optionalpartition: string
- OptionalcoreAttributes: string
- OptionalforceRefresh: boolean
Returns Promise<Profile>
Implementation of IProfileApi.getProfile
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:558

getProfileAttribute

getProfileAttribute(id: string, descriptor: string): Promise<ProfileAttribute>
Parameters
- id: string
- descriptor: string
Returns Promise<ProfileAttribute>
Implementation of IProfileApi.getProfileAttribute
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:96

getProfileAttributes

getProfileAttributes(
    id: string,
    partition: string,
    modifiedSince?: string,
    modifiedAfterRevision?: string,
    withCoreAttributes?: boolean,
    coreAttributes?: string,
): Promise<ProfileAttribute[]>
Parameters
- id: string
- partition: string
- OptionalmodifiedSince: string
- OptionalmodifiedAfterRevision: string
- OptionalwithCoreAttributes: boolean
- OptionalcoreAttributes: string
Returns Promise<ProfileAttribute[]>
Implementation of IProfileApi.getProfileAttributes
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:145

getRegions

getRegions(): Promise<ProfileRegions>
Returns Promise<ProfileRegions>
Implementation of IProfileApi.getRegions
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:651

getSupportedLcids

getSupportedLcids(): Promise<string[]>
Returns Promise<string[]>
Implementation of IProfileApi.getSupportedLcids
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:686

getUserDefaults

getUserDefaults(includeAvatar?: boolean): Promise<Profile>
Parameters
- OptionalincludeAvatar: boolean
Returns Promise<Profile>
Implementation of IProfileApi.getUserDefaults
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:722

refreshUserDefaults

refreshUserDefaults(id: string): Promise<Profile>
Parameters
- id: string
Returns Promise<Profile>
Implementation of IProfileApi.refreshUserDefaults
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:764

resetAvatar

resetAvatar(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Implementation of IProfileApi.resetAvatar
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:385

setAvatar

setAvatar(container: any, id: string): Promise<void>
Parameters
- container: any
- id: string
Returns Promise<void>
Implementation of IProfileApi.setAvatar
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:424

setProfileAttribute

setProfileAttribute(
    container: any,
    id: string,
    descriptor: string,
): Promise<void>
Parameters
- container: any
- id: string
- descriptor: string
Returns Promise<void>
Implementation of IProfileApi.setProfileAttribute
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:199

setProfileAttributes

setProfileAttributes(
    attributesCollection: VssJsonCollectionWrapperV<
        ProfileAttributeBase<any>[],
    >,
    id: string,
): Promise<void>
Parameters
- attributesCollection: VssJsonCollectionWrapperV<ProfileAttributeBase<any>[]>
- id: string
Returns Promise<void>
Implementation of IProfileApi.setProfileAttributes
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:245

updateProfile

updateProfile(profile: Profile, id: string): Promise<void>
Update profile
Parameters
- profile: Profile
  Update profile
- id: string
  Profile ID
Returns Promise<void>
Implementation of IProfileApi.updateProfile
- Defined in repos/azure-devops-node-api/api/ProfileApi.ts:613

Class ProfileApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProfileApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createProfile

Parameters

Returns Promise<Profile>

createRequestOptions

Parameters

Returns IRequestOptions

deleteProfileAttribute

Parameters

Returns Promise<void>

formatResponse

Parameters

Returns any

getAvatar

Parameters

Returns Promise<Avatar>

getAvatarPreview

Parameters

Returns Promise<Avatar>

getGeoRegion

Parameters

Returns Promise<GeoRegion>

getProfile

Parameters

Returns Promise<Profile>

getProfileAttribute

Parameters

Returns Promise<ProfileAttribute>

getProfileAttributes

Parameters

Returns Promise<ProfileAttribute[]>

getRegions

Returns Promise<ProfileRegions>

getSupportedLcids

Returns Promise<string[]>

getUserDefaults

Parameters

Returns Promise<Profile>

refreshUserDefaults

Parameters

Returns Promise<Profile>

resetAvatar

Parameters

Returns Promise<void>

setAvatar

Parameters

Returns Promise<void>

setProfileAttribute

Parameters

Returns Promise<void>

setProfileAttributes

Parameters

Returns Promise<void>

updateProfile

Parameters

Returns Promise<void>

Settings

On This Page