Class UserProfile

Represents a client-side user profile for a person. Note: The client-side UserProfile object provides methods you can use to create a personal site for the current user. However, it does not contain the user properties that the server-side UserProfile object contains. To access user properties from client-side code, use PeopleManager

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(): UserProfile

Returns

UserProfile

Methods

public createPersonalSite(lcid: number)

This member is reserved for internal use and is not intended to be used directly from your code. Use the createPersonalSiteEnque method to create a personal site.

Parameters

  • lcid: number

public createPersonalSiteEnque(isInteractive: boolean)

Enquees creation of a personal site for the current user.

Parameters

  • isInteractive: boolean

    Has a true value if the request is from a web browser and a false value if the request is from a client application.

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public fromJson(initValue: any)

Parameters

  • initValue: any

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_followedContent(): FollowedContent

Represents the content that the user is following.

Returns

FollowedContent

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_personalSite(): Site

Retrieves SP.Site object that represents the user's personal site.

Returns

Site

public get_personalSiteCapabilities(): PersonalSiteCapabilities

Specifies attributes of the user's personal site.

Returns

PersonalSiteCapabilities

public get_personalSiteInstantiationState(): PersonalSiteInstantiationState

Provides the state of the user's personal site

Returns

PersonalSiteInstantiationState

public get_pictureImportEnabled(): boolean

Specifies whether the user can import pictures

Returns

boolean

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public get_urlToCreatePersonalSite(): string

Specifies the URL to allow the current user to create a personal site.

Returns

string

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_objectVersion(value: string)

Parameters

  • value: string

public shareAllSocialData(shareAll: boolean)

Specifies whether the current user's social data is to be shared.

Parameters

  • shareAll: boolean