SP.UserProfiles.UserProfile object (sp.userprofiles)

Represents a client-side user profile for a person.

Applies to: apps for SharePoint | Office 365 | SharePoint Foundation 2013 | SharePoint Server 2013

In this article
Members
Methods
Properties
Remarks

var object = new SP.UserProfiles.UserProfile()

Members

The UserProfile object has the following members.

Constructor

The UserProfile object has the following constructor.

Constructor

Description

UserProfile

Methods

The UserProfile object has the following methods.

Method

Description

createPersonalSite

This member is reserved for internal use and is not intended to be used directly from your code.

createPersonalSiteEnque

Enqueues creating a personal site for this user, which can be used to share documents, web pages, and other files.

shareAllSocialData

Sets the privacy settings for this profile.

Properties

The UserProfile object has the following properties.

Property

Description

followedContent

Gets a FollowedContent object for the user.

personalSite

Gets the personal site of the user.

personalSiteCapabilities

Gets the capabilities of the user's personal site.

personalSiteInstantiationState

Gets the status for the state of the personal site instantiation.

pictureImportEnabled

Gets a Boolean value that indicates whether the user's picture is imported from Exchange.

urlToCreatePersonalSite

Gets the URL used to create the user's personal site.

Remarks

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 the one of the following methods from the PeopleManager object: getMyProperties and getPropertiesFor to retrieve all properties (which are stored in the PersonProperties.userProfileProperties property) or getUserProfilePropertiesFor and getUserProfilePropertyFor to retrieve specific properties.

See also

Other resources

SP.UserProfiles namespace