No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
ConnectApi Input Classes
Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that take no arguments.
Some methods take arguments typed with an abstract class. You must pass in an instance of a concrete child class for these arguments.
Most properties for the input classes can be set. Read-only properties are noted in this documentation.
ConnectApi.BinaryInput Class
Create a ConnectApi.BinaryInput object to attach files to feed items and comments.
The constructor is:
1ConnectApi.BinaryInput(blob, contentType, filename)The constructor takes these arguments:
ConnectApi.CanvasAttachmentInput Class
Used to attach a canvas app to a feed item.
Subclass of ConnectApi.FeedItemAttachmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| description | String | Optional. The description of the canvas app. | 29.0 |
| developerName | String | The developer name (API name) of the canvas app | 29.0 |
| height | String | Optional. The height of the canvas app in pixels. Default height is 200 pixels. | 29.0 |
| namespacePrefix | String | Optional. The namespace prefix of the Developer Edition organization in which the canvas app was created. | 29.0 |
| parameters | String | Optional. Parameters passed to the canvas app in JSON format.
Example: |
29.0 |
| thumbnailUrl | String | Optional. A URL to a thumbnail image for the canvas app. Maximum dimensions are 120x120 pixels. | 29.0 |
| title | String | The title of the link used to call the canvas app. | 29.0 |
ConnectApi.ChatterGroupInput Class
| Property | Type | Description | Available |
|---|---|---|---|
| canHaveChatterGuests | Boolean | true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false. | 29.0 |
| description | String | The “Description” section of the group | 29.0 |
| information | ConnectApi.GroupInformationInput Class | The “Information” section of a group. In the Web UI, this section is above the “Description” section. If the group is private, this section is visible only to members. | 28.0 |
| isArchived | Boolean | true if the group is archived, false otherwise. Defaults to false. | 29.0 |
| isAutoArchiveDisabled | Boolean | true if automatic archiving is turned off for the group, false otherwise. Defaults to false. | 29.0 |
| name | String | The name of the group | 29.0 |
| owner | String | The ID of the group owner. This property is available for PATCH requests only. | 29.0 |
| visibility | ConnectApi.GroupVisibilityType | Specifies whether a group
is private or public.
|
29.0 |
ConnectApi.CommentInput Class
Used to add rich comments, for example, comments that include @mentions or attachments.
| Property | Type | Description | Available Version |
|---|---|---|---|
| attachment | ConnectApi.FeedItemAttachmentInput Class | Optional. Specifies an attachment for the comment. Valid values
are:
|
28.0 |
| body | ConnectApi.MessageBodyInput Class | Description of message body. The body can contain up to 25 mentions. | 28.0 |
ConnectApi.ContentAttachmentInput Class
Used to attach existing content to a comment or feed item.
Subclass of ConnectApi.FeedItemAttachmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| contentDocumentId | String | ID of the existing content. | 28.0 |
ConnectApi.FeedItemAttachmentInput Class
Used to attach a file to a feed item.
This class is abstract and has no public constructor. You can make an instance only of a subclass.
ConnectApi.FeedItemInput Class
Used to add rich feed items, for example, feed items that include @mentions or files. Also used to bookmark a feed item.
| Property | Type | Description | Available Version |
|---|---|---|---|
| attachment | ConnectApi.FeedItemAttachmentInput Class | Specifies the attachment for the feed item. The feed item type is inferred based on the provided attachment. | 28.0 |
| body | ConnectApi.MessageBodyInput Class | Message body. The body can contain up to 25 mentions. | 28.0 |
| isBookmarkedByCurrentUser | Boolean | Specifies if the new feed item should be bookmarked for the user (true) or not (false). | 28.0 |
| originalFeedItemId | String | The 18-character ID of a feed item to share. | 28.0 |
| visibility | ConnectApi.FeedItemVisibilityType Enum | Specifies the type of feed item,
such as a content post, a text post, and so on.
|
28.0 |
ConnectApi.HashtagSegmentInput Class
Used to include a hashtag in a feed item or comment.
Subclass of ConnectApi.MessageSegmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| tag | String | Text of the hash tag without the # (hash tag) prefix | 28.0 |
ConnectApi.LinkAttachmentInput Class
Used as part of a feed item attachment, to add links.
Subclass of ConnectApi.FeedItemAttachmentInput Class
ConnectApi.LinkSegmentInput Class
Used to include a link segment in a feed item or comment.
Subclass of ConnectApi.MessageSegmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| url | String | URL to be used for the link | 28.0 |
ConnectApi.MentionSegmentInput Class
Used to include an @mention of a user or a group in a feed item or a comment. The maximum number of mentions you can include in a feed item or comment is 25.
Subclass of ConnectApi.MessageSegmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| id | String | ID of the user or group to be mentioned | 28.0 Groups are available in 29.0 |
ConnectApi.MessageBodyInput Class
Used to add rich messages to feed items and comments.
| Property | Type | Description | Available Version |
|---|---|---|---|
| messageSegments | List<ConnectApi.MessageSegmentInput Class> | List of message segments contained in the body | 28.0 |
ConnectApi.MessageSegmentInput Class
Used to add rich message segments to feed items and comments.
This class is abstract and has no public constructor. You can make an instance only of a subclass.
ConnectApi.NewFileAttachmentInput Class
Describes a new file to be attached to a feed item. The actual binary file, that is the attachment, is provided as part of the BinaryInput in the method that takes this attachment input, such as postFeedItem or postComment.
Subclass of ConnectApi.FeedItemAttachmentInput Class
ConnectApi.PhotoInput Class
Use to specify how crop a photo. Use to specify an existing file (a file that has already been uploaded).
| Property | Type | Description | Available version |
|---|---|---|---|
| cropSize | Integer | The length, in pixels, of any edge of the crop square. | 29.0 |
| cropX | Integer | The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0). | 29.0 |
| cropY | Integer | The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0). | 29.0 |
| fileId | String | 18 character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 MB. | 25.0 |
| versionNumber | Integer | Version number of the existing content. If not provided, the latest version is used. | 25.0 |
ConnectApi.PollAttachmentInput Class
Used to attach a poll to a feed item.
Subclass of ConnectApi.FeedItemAttachmentInput Class
ConnectApi.TextSegmentInput Class
Used to include a text segment in a feed item or comment.
Subclass of ConnectApi.MessageSegmentInput Class
| Property | Type | Description | Available Version |
|---|---|---|---|
| text | String | Plain text for this segment. If hashtags or links are detected in text, they are included in the comment as hashtag and link segments. Mentions are not detected in text and are not separated out of the text. Mentions require ConnectApi.MentionSegmentInput Class. | 28.0 |
ConnectApi.TopicInput Class
Used to update a topic’s description and the spacing and capitalization of a topic’s name.
ConnectApi.UserInput Class
Used to update a user.
| Property | Type | Description | Available Version |
|---|---|---|---|
| aboutMe | String | The aboutMe property of a ConnectApi.UserDetail output object. This property populates the “About Me” section of the user profile, which is visible to all members of a community or organization. | 29.0 |