Reference Apex Classes

records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif
icons in an email.
Note: The motif images are icons, not user uploaded images or photos. For example, every user has the same set of
motif icons.

Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style:

"motif": {
"largeIconUrl": "/img/icon/custom51_100/boat64.png",
"mediumIconUrl": "/img/icon/custom51_100/boat32.png",
"smallIconUrl": "/img/icon/custom51_100/boat16.png"
},

Users use the following icons:

"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},

Groups use the following icons:

"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},

Files use the following icons:

"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},

Note: To view the icons in the previous examples, preface the URL with https://instance_name. For example,
https://instance_name/img/icon/profile64.png.

Name Type Description

largeIconUrl String A large icon indicating the record type.
mediumIconUrl String A medium icon indicating the record type.
smallIconUrl String A small icon indicating the record type.

ConnectApi.OrganizationSettings Class

Name Type Description

accessTimeout Integer Amount of time after which the system prompts users who have
been inactive to log out or continue working

602
Reference Apex Classes

Name Type Description

features ConnectApi.Features Information about features available in the organization
Class

name String Organization name

orgId String 18-character ID for the organization
userSettings ConnectApi.UserSettings Information about the organization permissions for the user
Class

ConnectApi.PhoneNumber Class

Name Type Description

phoneNumber String Phone number
type String Values are:
• Fax
• Mobile
• Work

ConnectApi.Photo Class

Name Type Description

fullEmailPhotoUrl String A temporary URL to the large profile picture. The URL expires
after 30 days and is available to unauthenticated users.
largePhotoUrl String URL to the large profile picture. The default width is 200 pixels,
and the height is scaled so the original image proportions are
maintained.
photoVersionId String 18–character Id to that version of the photo
smallPhotoUrl String URL to the small profile picture. The default size is 64x64 pixels.
standardEmailPhotoUrl String A temporary URL to the small profile. The URL expires after 30
days and is available to unauthenticated users.
url String A resource that returns a Photo object: for example,
/services/data/v28.0/chatter/users/005D0000001LL8OIAW/photo.

ConnectApi.RecordSummary Class
Child class of ConnectApi.ActorWithId Class
No additional properties. This is a generic record which doesn’t have special child classes.

ConnectApi.Reference Class
Child class of ConnectApi.MessageSegment Class

603
Reference Apex Classes

Name Type Description

id String 18–character id of the object being referenced
url String URL to the resource

ConnectApi.ResourceLinkSegment Class

Name Type Description

url String URL to a resource not otherwise identified by an ID field, for
example, a link to a list of users.

ConnectApi.Subscription Class

Name Type Description

community ConnectApi. Information about the community in which the subscription exists
Reference Class

id String Subscription’s 18–character Id

subject ConnectApi.Actor Information about the parent, that is, the thing or person being
Class followed
subscriber ConnectApi.Actor Information about the subscriber, that is, the person following this
Class item
url String Chatter REST API URL to this specific subscription

ConnectApi.TextSegment Class
Child class of ConnectApi.MessageSegment Class
No additional properties.

ConnectApi.UnauthenticatedUser Class
Child class of ConnectApi.Actor Class
No additional properties.
Instances of this class are used as the actor for feed items and comments posted by Chatter customers.

ConnectApi.User
Super class of:
• ConnectApi.UserDetail Class
• ConnectApi.UserSummary Class
Child class of ConnectApi.ActorWithId Class

Name Type Description

companyName String Name of the company

604
Reference Apex Classes

Name Type Description

firstName String User's first name
isChatterGuest Boolean true if user is a Chatter customer; false otherwise.

isInThisCommunity Boolean true if user is in the same community as the context user; false
otherwise
lastName String User's last name
photo ConnectApi.Photo Information about the user's photos
Class

title String User’s title

userType ConnectApi. Specifies the type of user.
UserType Enum • ChatterGuest—User is a Chatter customer in an external
group
• ChatterOnly—User is a Chatter Free customer
• Guest—Unauthenticated users
• Internal—User is a standard organization member
• Portal—User is a Customer Portal User, a communities user,
and so on.
• System—User is Chatter Expert or a system user
• Undefined—User is a user type that is a custom object.

ConnectApi.UserChatterSettings Class
A user’s global Chatter settings.

Name Type Description

defaultGroupEmailFrequency ConnectApi. The default frequency with which a user receives email from a
GroupEmail group when they join it.
Frequency Enum

ConnectApi.UserDetail Class
Child class of ConnectApi.User
If the context user doesn’t have permission to see a property, its value is set to null.

Name Type Description

aboutMe String Text from user's profile
address ConnectApi.Address User’s address
Class

chatterActivity ConnectApi. Chatter activity statistics

ChatterActivity
Class

605
Reference Apex Classes

Name Type Description

chatterInfluence ConnectApi.Global User’s influence rank
Influence Class

email String User's email address

followersCount Integer Number of users following this user
followingCounts ConnectApi. Information about items the user is following
FollowingCounts
Class

groupCount Integer Number of groups user is following

isActive Boolean true if user is active; false otherwise

managerId String 18–character Id of the user’s manager

managerName String Locale-based concatenation of manager's first and last names
phoneNumbers List<ConnectApi. Collection of user's phone numbers
PhoneNumber
Class>

username String Username of the user, such as Admin@mycompany.com.

ConnectApi.UserGroupPage Class

Name Type Description

currentPageUrl String Chatter REST API URL identifying the current page
groups List<ConnectApi. List of groups
ChatterGroup
Summary Class>

nextPageUrl String Chatter REST API URL of the next page

previousPageUrl String Chatter REST API URL of the previous page
total Integer Total number of groups across all pages

ConnectApi.UserPage Class

Name Type Description

currentPageToken Integer Token identifying the current page
currentPageUrl String Chatter REST API URL identifying the current page
nextPageToken Integer Token identifying the next page
nextPageUrl String Chatter REST API URL identifying the next page
previousPageToken Integer Token identifying the previous page
previousPageUrl String Chatter REST API URL identifying the previous page

606