Newer Version Available

This content describes an older version of this product. View Latest

UserProfiles Class

Access user profile data. The user profile data populates the profile page (also called the Chatter profile page). This data includes user information (such as address, manager, and phone number), some user capabilities (permissions), and a set of subtab apps, which are custom tabs on the profile page.

Namespace

ConnectApi

UserProfiles Methods

These methods are for UserProfiles. All methods are static.

All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.

deleteBannerPhoto(communityId, userId)

Delete a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static Void deleteBannerPhoto(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.

Return Value

Type: Void

deletePhoto(communityId, userId)

Delete a user’s photo.

API Version

35.0

Requires Chatter

Yes

Signature

public static Void deletePhoto(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.

Return Value

Type: Void

getBannerPhoto(communityId, userId)

Get a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto getBannerPhoto(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.

Return Value

Type: ConnectApi.BannerPhoto

getPhoto(communityId, userId)

Get a user’s photo.

API Version

35.0

Available to Guest Users

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo getPhoto(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.

Return Value

Type: ConnectApi.Photo

getUserProfile(communityId, userId)

Get the user profile of the context user.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.UserProfile getUserProfile(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.

Return Value

Type: ConnectApi.UserProfile

setBannerPhoto(communityId, userId, fileId, versionNumber)

Set an uploaded file as a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String userId, String fileId, Integer versionNumber)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.
fileId: Type: String; ID of the uploaded file to use as the user banner. The key prefix must be 069, and the image must be smaller than 8 MB.
versionNumber: Type: Integer; Version number of the file. Specify an existing version number or, to get the latest version, specify null.

Return Value

Type: ConnectApi.BannerPhoto

Usage

Photos are processed asynchronously and might not be visible right away.

setBannerPhoto(communityId, userId, fileUpload)

Set a file that hasn’t been uploaded as a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String userId, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.BannerPhoto

Usage

Photos are processed asynchronously and might not be visible right away.

setBannerPhotoWithAttributes(communityId, userId, bannerPhoto)

Set and crop an uploaded file as a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String userId, ConnectApi.BannerPhotoInput bannerPhoto)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.
bannerPhoto: Type: ConnectApi.BannerPhotoInput; A ConnectApi.BannerPhotoInput object that specifies the ID and version of the file, and how to crop the file.

Return Value

Type: ConnectApi.BannerPhoto

Usage

Photos are processed asynchronously and might not be visible right away.

setBannerPhotoWithAttributes(communityId, userId, bannerPhoto, fileUpload)

Set and crop a file that hasn’t been uploaded as a user’s banner photo.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String userId, ConnectApi.BannerPhotoInput bannerPhoto, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID of the user.
bannerPhoto: Type: ConnectApi.BannerPhotoInput; A ConnectApi.BannerPhotoInput object specifying the cropping parameters.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.BannerPhoto

Usage

Photos are processed asynchronously and might not be visible right away.

setPhoto(communityId, userId, fileId, versionNumber)

Set an uploaded file as a user’s photo.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String userId, String fileId, Integer versionNumber)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.
fileId: Type: String; ID of an uploaded file. The file must be an image, and be smaller than 2 GB.
versionNumber: Type: Integer; Version number of the existing file. Specify either an existing version number, or null to get the latest version.

Return Value

Type: ConnectApi.Photo

Usage

Photos are processed asynchronously and might not be visible right away.

setPhoto(communityId, userId, fileUpload)

Set a file that hasn’t been uploaded as a user’s photo.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String userId, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

Photos are processed asynchronously and might not be visible right away.

setPhotoWithAttributes(communityId, userId, photo)

Set and crop an uploaded file as a user’s photo.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String userId, ConnectApi.PhotoInput photo)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object specifying the file ID, version number, and cropping parameters.

Return Value

Type: ConnectApi.Photo

Usage

Photos are processed asynchronously and might not be visible right away.

setPhotoWithAttributes(communityId, userId, photo, fileUpload)

Set and crop a file that hasn’t been uploaded as a user’s photo.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String userId, ConnectApi.PhotoInput photo, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object specifying the cropping parameters.
fileUpload: Type: ConnectApi.BinaryInput; File to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

Photos are processed asynchronously and might not be visible right away.

Apex Reference Guide

UserProfiles Class

Namespace

UserProfiles Methods

deleteBannerPhoto(communityId, userId)

API Version

Requires Chatter

Signature

Parameters

Return Value

deletePhoto(communityId, userId)

API Version

Requires Chatter

Signature

Parameters

Return Value

getBannerPhoto(communityId, userId)

API Version

Requires Chatter

Signature

Parameters

Return Value

getPhoto(communityId, userId)

API Version

Available to Guest Users

Requires Chatter

Signature

Parameters

Return Value

getUserProfile(communityId, userId)

API Version

Requires Chatter

Signature

Parameters

Return Value

setBannerPhoto(communityId, userId, fileId, versionNumber)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setBannerPhoto(communityId, userId, fileUpload)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setBannerPhotoWithAttributes(communityId, userId, bannerPhoto)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setBannerPhotoWithAttributes(communityId, userId, bannerPhoto, fileUpload)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setPhoto(communityId, userId, fileId, versionNumber)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setPhoto(communityId, userId, fileUpload)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

setPhotoWithAttributes(communityId, userId, photo)

API Version

Requires Chatter