Share via

SP.UserProfiles namespace (sp.userprofiles)

  • Article

Use PeopleManager and other objects in the SP.UserProfiles namespace to get user profiles and user properties in custom solutions for SharePoint 2013 and apps for SharePoint.

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

Members

The SP.UserProfiles namespace in the SP.UserProfiles.js JavaScript library contains the following public objects and enumerations.

Objects

Object

Description

HashTag

Represents a hash tag in the collection of trending tags.

HashTagCollection

Represents a collection of hash tags in microblog posts. This collection is returned by the getTrendingTags method.

PeopleManager

Provides methods for operations related to people.

PersonProperties

Represents user properties.

ProfileLoader

Provides an alternate entry point to user profiles rather than calling methods directly.

UserProfile

Represents a client-side user profile for a person.

UserProfilePropertiesForUser

Represents a set of user profile properties for a specified user.

Enumerations

Enumeration

Description

ChangeTypes

Specifies types of changes made in the user profile store.

ObjectTypes

Specifies types of user-related objects that can be changed in the user profile store.

PersonalSiteCapabilities

Specifies the capabilities of a personal site.

PersonalSiteInstantiationState

Specifies an exception or status code for the state of a personal site instantiation.

Internal API in the SP.UserProfiles namespace

The following items from the SP.UserProfiles namespace are removed from this reference because they are reserved for internal use and not intended to be used directly from your code:

  • Followed objects and enumerations. You can access Following People features and Following Content features by using the SocialFollowingManager object and related API in the SP.Social namespace.

    • FollowedContent

    • FollowedItem

    • FollowedItemData

    • FollowResult

    • FollowedContentExceptionCode

    • FollowedContentQueryOptions

    • FollowedItemType

    • FollowedStatus

    • FollowResultType

  • ProfileImageStore object

  • Internal constructors

  • initPropertiesFromJson methods, writeToXml methods, newObject methods, childItemType properties, and typeId properties

  • <Object> PropertyNames objects and <Object>ObjectPropertyNames objects

See also

Other resources

SharePoint User Profiles JavaScript Reference (sp.userprofiles.js)

Work with user profiles in SharePoint 2013

Follow people in SharePoint 2013