Methods
Create
Creates an ActivityMessage
Usage
#set($activityMessageResponse = $core_v2_activityMessage.Create($messageBody, $messageType, $messageSubject))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| messageBody | string | Content of the message | Required | | |
| messageType | string | Type of message | Required | | NewBlog, NewBlogComment, NewBlogPost, NewComment, NewForum, NewForumPost, NewForumThread, NewFriendship, NewGroup, NewGroupMember, NewGroupPage, NewMediaGallery, NewMediaGalleryComment, NewMediaGalleryPost, NewProfileAnnouncement, NewProfileComment, NewUser, NewUserAvatar, NewUserFile, NewUserFolder, NewWiki, NewWikiPage, NewWikiPageComment, Status, ThirdPartyMessageType, UpdatedWikiPage |
| messageSubject | string | Subject of the message | Required | | |
Return Type
ActivityMessage
Create
Creates an ActivityMessage
Usage
#set($activityMessageResponse = $core_v2_activityMessage.Create($messageBody, $messageType, $messageSubject, "%{ContentId = $contentIdArg, DateCreated = $dateCreatedArg, GroupId = $groupIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| messageBody | string | Content of the message | Required | | |
| messageType | string | Type of message | Required | | NewBlog, NewBlogComment, NewBlogPost, NewComment, NewForum, NewForumPost, NewForumThread, NewFriendship, NewGroup, NewGroupMember, NewGroupPage, NewMediaGallery, NewMediaGalleryComment, NewMediaGalleryPost, NewProfileAnnouncement, NewProfileComment, NewUser, NewUserAvatar, NewUserFile, NewUserFolder, NewWiki, NewWikiPage, NewWikiPageComment, Status, ThirdPartyMessageType, UpdatedWikiPage |
| messageSubject | string | Subject of the message | Required | | |
| ContentId | string | Content Id | Optional | | |
| DateCreated | DateTime | Message Date | Optional | | |
| GroupId | int | Group in which to create the message | Optional | | |
Return Type
ActivityMessage
Delete
Deletes an activity message
Usage
#set($additionalInfoResponse = $core_v2_activityMessage.Delete($messageId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| messageId | Guid | Id of message to delete | Required | | |
Return Type
AdditionalInfo
Get
Gets a single ActivityMessage
Usage
#set($activityMessageResponse = $core_v2_activityMessage.Get($messageId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| messageId | Guid | Id of the ActivityMessage | Required | | |
Return Type
ActivityMessage
List
Lists Activity Messages
Usage
#set($apiListResponse = $core_v2_activityMessage.List())
Return Type
ApiList<ActivityMessage>
List
Lists Activity Messages
Usage
#set($apiListResponse = $core_v2_activityMessage.List("%{AfterDate = $afterDateArg, BeforeDate = $beforeDateArg, ExcludeActivityTypes = $excludeActivityTypesArg, GroupId = $groupIdArg, GroupSimilarActivities = $groupSimilarActivitiesArg, Include = $includeArg, IncludeActivityTypes = $includeActivityTypesArg, IncludeStatus = $includeStatusArg, IncludeSubGroups = $includeSubGroupsArg, PageSize = $pageSizeArg, UserId = $userIdArg, Username = $usernameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| AfterDate | DateTime | Retrieve status messages posted after the date specified. | Optional | | |
| BeforeDate | DateTime | Specify BeforeDate to only retrieve activity messages posted from that date and before. | Optional | | |
| ExcludeActivityTypes | string | comma-delimited list of activity types to filter results for all types except those specified. Status messages are always excluded unless IncludeStatus is set to true. | Optional | | NewBlog, NewBlogComment, NewBlogPost, NewComment, NewForum, NewForumPost, NewForumThread, NewFriendship, NewGroup, NewGroupMember, NewGroupPage, NewMediaGallery, NewMediaGalleryComment, NewMediaGalleryPost, NewProfileAnnouncement, NewProfileComment, NewUser, NewUserAvatar, NewUserFile, NewUserFolder, NewWiki, NewWikiPage, NewWikiPageComment, Status, ThirdPartyMessageType, UpdatedWikiPage |
| GroupId | int | Used to return group activities. | Optional | | |
| GroupSimilarActivities | bool | Whether to group similar activities | Optional | | |
| Include | string | Include | Optional | | following, groups, replies |
| IncludeActivityTypes | string | comma-delimited set of activity types to filter results for only those types specified. | Optional | | NewBlog, NewBlogComment, NewBlogPost, NewComment, NewForum, NewForumPost, NewForumThread, NewFriendship, NewGroup, NewGroupMember, NewGroupPage, NewMediaGallery, NewMediaGalleryComment, NewMediaGalleryPost, NewProfileAnnouncement, NewProfileComment, NewUser, NewUserAvatar, NewUserFile, NewUserFolder, NewWiki, NewWikiPage, NewWikiPageComment, Status, ThirdPartyMessageType, UpdatedWikiPage |
| IncludeStatus | bool | Status messages are not included with activity messages by default - regardless if they are included in the IncludeActivityTypes parameter. If you set this property to true then Status messages will be included with the list of activity messages. | Optional | | |
| IncludeSubGroups | bool | Used when specifying a group to include activity messages for all sub-groups as well. Default is false. It is strongly suggested to also specify a BeforeDate when including sub-groups to limit the number of messages in the response. | Optional | false | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| UserId | int | Either UserId or Username required. | Optional | | |
| Username | string | Either UserId or Username required. | Optional | | |
Return Type
ApiList<ActivityMessage>