You are on page 1of 5

Reference Apex Classes

Name Type Description


• Rejected
• Removed
• Started

ConnectApi.ApprovalPostTemplateField Class

Name Type Description


displayName String The field name
displayValue String The field value or null if the field is set to null.
record ConnectApi. A record ID
Reference Class
If no record exists or if the reference is null, this value is null.

ConnectApi.BasicTemplateAttachment Class
Child class of ConnectApi.FeedItemAttachment Class.
Objects of this type are returned by attachments in feed items with type BasicTemplate.

Property Type Description


description String An optional description with a 500 character limit.
icon ConnectApi.Icon An optional icon.
Class

linkRecordId String If linkURL refers to a Salesforce record, linkRecordId contains


the ID of the record.
linkUrl String An optional URL to a detail page if there is additional content
that can’t be displayed inline. Do not specify linkUrl unless you
specify a title.
title String An optional title to the detail page. If linkUrl is specified, the
title links to linkUrl.

ConnectApi.CaseComment Class
Child class of ConnectApi.FeedItemAttachment Class
Objects of this type are returned by attachments in feed items with type CaseCommentPost.

Name Type Description


actorType ConnectApi. Specifies the type of user who made the comment.
CaseActorType • Customer—if a Chatter customer made the comment
Enum • CustomerService—if a service representative made the
comment

582
Reference Apex Classes

Name Type Description


createdBy ConnectApi.User Comment’s creator
Summary Class

createdDate Datetime ISO8601 date string, for example, 2011-02-25T18:24:31.000Z


id String Comment’s 18–character Id
published Boolean Specifies whether the comment has been published
text String Comment’s text

ConnectApi.ChatterActivity Class

Name Type Description


commentCount Integer Total number of comments in the organization or community
made by the user
commentReceivedCount Integer Total number of comments in the organization or community
received by the user
likeReceivedCount Integer Total number of likes on posts and comments in the organization
or community received by the user
postCount Integer Total number of posts in the organization or community made by
the user

ConnectApi.ChatterGroup Class
This class is abstract.
Super class for:
• ConnectApi.ChatterGroupDetail Class
• ConnectApi.ChatterGroupSummary Class
Child class of ConnectApi.ActorWithId Class.

Name Type Description


canHaveChatterGuests Boolean true if this group allows Chatter

community ConnectApi. Information about the community the group is in


Reference Class

description String Group’s description


emailToChatterAddress String Reserved for future use
lastFeedItemPostDate Datetime ISO8601 date string, for example, 2011-02-25T18:24:31.000Z
of the most recent feed item posted to the group.
memberCount Integer Total number of group members
myRole ConnectApi. Specifies the type of membership the user has with the group, such
GroupMembership as group owner, manager, or member.
Type Enum • GroupOwner

583
Reference Apex Classes

Name Type Description


• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember

mySubscription ConnectApi. If the context user is a member of this group, contains information
Reference Class about that subscription; otherwise, returns null.
name String Name of the group.
owner ConnectApi.User Information about the owner of the group.
Summary Class

photo ConnectApi.Photo Information about the group photo


Class

visibility ConnectApi. Specifies whether a group is private or public. Valid values are:
GroupVisibility • PrivateAccess
Type Enum • PublicAccess

ConnectApi.ChatterGroupDetail Class
Child class of ConnectApi.ChatterGroup Class.

Name Type Description


fileCount Integer The number of files posted to the group.
information ConnectApi.Group Describes the “Information” section of the group. In the Web UI,
Information Class this section is above the “Description” section. If the group is
private, this section is visible only to members. If the context user
is not a member of the group or does not have “Modify All Data”
or “View All Data” permission, this value is null.

ConnectApi.ChatterGroupPage Class

Name Type Description


currentPageUrl String Chatter REST API URL to this page of groups
groups List<ConnectApi. List of group details
ChatterGroup
Detail Class>

nextPageUrl String Chatter REST API URL identifying the next page of groups
previousPageUrl String Chatter REST API URL identifying the previous page of groups

ConnectApi.ChatterGroupSummary Class
Child class of ConnectApi.ChatterGroup Class.

584
Reference Apex Classes

ConnectApi.ChatterLike Class

Name Type Description


id String Like’s 18-character Id
likedItem ConnectApi. A reference to the liked comment or feed item.
Reference Class

url String Like’s Chatter REST API URL


user ConnectApi.User Like’s creator
Summary Class

ConnectApi.ChatterLikePage Class

Name Type Description


currentPageToken Integer Token identifying the current page of likes
currentPageUrl String Chatter REST API URL identifying the current page of likes
likes List<ConnectApi. List of likes
ChatterLike
Class>

nextPageToken Integer Token identifying the next page of likes


nextPageUrl String Chatter REST API URL identifying the next page of likes
previousPageToken Integer Token identifying the previous page of likes
previousPageUrl String Chatter REST API URL identifying the previous page of likes
total Integer Total number of likes across all pages

ConnectApi.ClientInfo Class

Name Type Description


applicationName String Name of the Connected App used for authentication.
applicationUrl String Value from the Info URL field of the Connected App used for
authentication

ConnectApi.Comment Class

Name Type Description


attachment ConnectApi. If the comment contains an attachment, property value is
FeedItem ContentAttachment. If the comment does not contain an
Attachment Class attachment, it is null.
body ConnectApi. Body of the comment
FeedBody Class

585
Reference Apex Classes

Name Type Description


clientInfo ConnectApi. Information about the Connected App used to authenticate the
ClientInfo Class connection
createdDate Datetime ISO8601 date string, for example, 2011-02-25T18:24:31.000Z
feedItem ConnectApi. Information about the feed item
Reference Class

id String Comment’s 18–character Id


isDeleteRestricted Boolean If this property is true the comment cannot be deleted by the
context user. If it is false, it might be possible for the context
user to delete the comment, but it is not guaranteed.
likes ConnectApi. The first page of likes for the comment
ChatterLikePage
Class

likesMessage ConnectApi. A message body that describes who likes the comment.
MessageBody Class

myLike ConnectApi. If the context user has liked the comment, this property is a
Reference Class reference to the specific like, null otherwise
parent ConnectApi. Information about the parent feed-item for this comment
Reference Class

relativeCreatedDate String The created date formatted as a relative, localized string, for
example, “17m ago” or “Yesterday.”
type ConnectApi.CommentType Specifies the type of comment.
Enum • ContentComment—the comment contains an attachment
• TextComment—the comment contains only text

url String Chatter REST API URL to this comment


user ConnectApi.User Information about the comment author
Summary Class

ConnectApi.CommentPage Class

Name Type Description


comments List<ConnectApi. Collection of comments
Comment Class>

currentPageToken String Token identifying the first page of comments.


currentPageUrl String Chatter REST API URL identifying the first page of comments,
that is, the most recent comments.
nextPageToken String Token identifying the next page of comments.
nextPageUrl String Chatter REST API URL identifying the next page of comments,
that is, older comments.
total Integer Total number of comments for the parent feed item

586

You might also like