Service Info: activity
Service Description
This service provides the core functions needed for interaction of the collaboration and social networking features of Hornbill ESP.
Available Operations
The following operations are available for the activity service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| activityChangeStatus | Invoke this operation to change the status for a post. You must be the owner of the post or have Super User Role to change the status. |
| activityChangeVisibility | Invoke this operation to change a visibility for a post. You must be the owner of the post or have Super User Role to change the visibility. The change of visibility for a post is only allowed for Activity Stream of type Entity. |
| activityDeleteComment | Deletes a comment previously posted to an activity. This is only allowed if there are no likes. You must be the owner of the comment or have Super User Role to perform this operation |
| activityDeregister | Invoke this operation to destroy an activity. This can only be invoked by either the owner of the activity, the owner of the activity stream or an administrator. If the actor is the owner of the activity stream it will destroy all comments and likes related to the activity. If the user is the not the owner of the activity stream but is the owner of the activity or and administrator then the activity will only be removed if there are no comments or likes |
| activityEditComment | Edits a comment previously posted to an activity. This is only allowed if there are no likes. You must be the owner of the comment or have Super User Role to perform this operation |
| activityEditMessage | Edits a post for a specified activity stream. This is only allowed if there are no comments or likes. You must be the owner of the post or have Super User Role to perform this operation. |
| activityGetEmbeddedInfo | Invoke this operation to get information and access tokens to the embedded content of this activity or comment. One of the id parameters has to be present |
| activityInvalidateDisplayNameCache | Use this operation to clear a single cached item or the whole cache. The cache is loaded on demand so by clearing the cache you are forcing the system to re-query the database for the social objects display name the next time it is needed. Typically this is used after you have edited a database record that would alter the display name shown in the activity stream output |
| activityMoveMessage | Moves a post to the specified activity stream. You must be the owner of the post or have Super User Role to perform this operation. |
| activityPostComment | Posts a comment to the specified activity. |
| activityPostCommentImage | Posts an image comment to the specified activity. |
| activityPostImage | Posts an update to the specified activity stream. If the socialObjectRef referenced an object user as a user or other object and that object exists but does not have and associated activity stream, the activity stream will be created automatically. |
| activityPostMessage | Posts an update to the specified activity stream. The activity stream must exist. |
| activityRegister | Invoke this operation to register a new activity such as a like or post. It should be avoided for activities that already have methods defined such as postMessage. An activity tells a story, such as Bob posted a picture on Jim's Buzz. |
| activitySearch | This method searches the activity index and returns a list of messages matching this query. |
| activityStreamDeregister | Invoke this operation to destroy an activity stream. All contained activities, associated objects and strings, and follows are deleted. Following users are sent a notification that the stream is gone. |
| activityStreamFollow | Invoke this method to follow an activity stream. |
| activityStreamGetFollowers | Invoke this operation to get a list of people who are following the specified activity stream. |
| activityStreamGetUnreadCount | This operation gets number of messages not yet seen by invoking user in the specified activity stream(s). Users can only query activity streams that they either own or belong to. The unread counts returned are specific to user account invoking this operation, each user will have different unread counts depending when they last visited the activity stream. The unread status for each activity stream remains unaffected after invoking this operation. |
| activityStreamGetVisibility | You can use this method to lookup the visibility you have on the specified activity stream. |
| activityStreamLookup | You can use this method to lookup the activity stream ID for a given social object. |
| activityStreamQuery | Use this operation to get the contents of the specified activity stream. |
| activityStreamQueryComments | Use this operation to get the comments for the specified activity. |
| activityStreamQueryItem | Use this operation to get the contents of the specified activity. |
| activityStreamRegister | Invoke this operation to register a new activity stream such as a Buzz or comment stream. It should be avoided for actions which already have methods defined. An activity stream is a list of activities that can be followed. |
| activityStreamSetStatus | Sets the status of the specified activity stream |
| activityStreamSetVisibility | You can use this method to set visibility of a social object on specified activity stream. You need to be an owner of the activity stream to set the visibility. You cannot set visibility of a social object on a workspace. |
| activityStreamUnfollow | Invoke this method to stop following an activity stream. |
| conversationAdd | Use this operation to add participants for a specific conversation. |
| conversationDelete | Use this operation to delete the conversation. Deleting the conversation only deletes it from your view, the other participants will still be able to see the conversation. |
| conversationGetList | Use this operation to get a list of active conversations. |
| conversationGetMessages | Use this operation to get the messages for a specific conversation. |
| conversationGetUnreadCount | This operation gets number of messages not yet seen by invoking user in the specified conversation(s). Users can only query conversation that they either own or belong to. The unread counts returned are specific to user account invoking this operation, each user will have different unread counts depending when they last visited the conversation. The unread status for each conversation remains unaffected after invoking this operation. |
| conversationPost | Posts a message to a conversation. |
| conversationPostImage | Posts an image to a conversation. |
| conversationSearch | This method searches the conversation(s) and returns a list of messages matching this query. |
| conversationStart | Initiate a conversation between yourself and one or more other users. |
| follow | Invoke this method to follow a user or object's activity stream. |
| getFollowCounters | Invoke this operation to get a count of followers and following for the specified social object. |
| getFollowers | Invoke this operation to get a list of people who are following the specified social object. |
| getFollowersCount | Invoke this operation to get a count of people who are following the specified social object. |
| getFollowing | Invoke this operation to get a list of people being followed by the specified social object. |
| getFollowingCount | Invoke this operation to get a count of people being followed by the specified social object. |
| getLikes | Invoke this method to get a list of likes for the specified activity or comment. |
| getUnreadCounters | This api will return the total unread message count (by you) for both the conversations and workspaces. You can only query conversations or workspaces that you either own or belong to. The unread count returned are specific to each user account/session and their involvement in conversations/workspaces. In simple term each user will have a different unread counts depending when they have last visited the workspace/conversations. The unread status for each workspace/conversation remains unaffected after invoking this operation. |
| getVisibility | You can use this method to lookup the visibility you have on the specified users activity stream. |
| like | Invoke this method to like an activity or comment. |
| newsFeedQuery | Use this operation to query your syndicated news feed. |
| newsfeedSearch | This method searches the activity index and returns a list of messages matching this query. |
| postImage | Posts an update to the specified social objects Buzz/activity stream. If the socialObjectRef referenced an object user as a user or other object and that object exists but does not have and associated activity stream, the activity stream will be created automatically. |
| postMessage | Posts an update to the specified social objects Buzz/activity stream. If the socialObjectRef referenced an object user as a user or other object and that object exists but does not have and associated activity stream, the activity stream will be created automatically. |
| profileImageDelete | Use this operation to delete a social objects profile image. |
| profileImageGet | Use this operation to get a URI reference pointer to a static profile image related to the social object reference. |
| profileImageSet | Use this operation to set a profile image for a user, contact or other supported social object. The system will always convert the provided image into a JPG of various system required sizes and store these in the data cache. The system will aggressively cache these images and URN mappings to the same in order to provide high performance implied location and regular access capability. It should be noted that for performance reasons, images set here are in effect public and are not subject to security and access controls. If a profile image for the specified social object already exists, it will be replaced. |
| unfollow | Invoke this method to stop following a user or object's activity stream. |
| unlike | Invoke this method to unlike an activity or comment you previously liked. |
| wallQuery | Use this operation to get the contents of the specified social objects Buzz. |
| wallQueryItem | Use this operation to get the activity from the specified social objects Buzz. |
| workspaceAddMember | Invoke this operation to add one or more new members to the workspace. You need to be the workspace owner or have admin privilege level or have changeWorkspaceOwner system right (only applicable for Public Workspaces) in order to add a member to a workspace. |
| workspaceChangeOwner | Invoke this operation to change the owner of a workspace to another user. You need to be the current owner or have an ADMIN privilege level or have changeWorkspaceOwner System Right to change a workspace ownership |
| workspaceCreate | Invoke this operation to create a new workspace. A workspace is essentially an extended activity stream with group management behavior. |
| workspaceDelete | Invoke this operation to delete a workspace. |
| workspaceGetInfo | Invoke this operation to get information about the specified workspace. |
| workspaceGetList | Invoke this operation to get a list of workspaces |
| workspaceGetMembers | Invoke this operation to get a list of workspace members. If workspace is not public then you need to be the workspace owner or a member to invoke this operation |
| workspaceGetUnreadCount | This operation gets number of messages not yet seen by invoking user in the specified workspace(s). Users can only query workspaces that they either own or belong to. The unread counts returned are specific to user account invoking this operation, each user will have different unread counts depending when they last visited the workspace. The unread status for each workspace remains unaffected after invoking this operation. |
| workspaceJoin | Invoke this operation to join a public workspace or request to join a closed workspace. Membership to public workspace is granted immediately but membership to closed workspace is granted upon approval by the workspace owner. New task will be created for the workspace owner to approve/reject the join request. |
| workspaceJoinGetStatus | Invoke this operation to get a list of workspaces join request status. |
| workspaceLeave | Invoke this operation to leave any workspace which you are a member of. You can remove only yourself in any public workspaces. |
| workspaceLookup | Invoke this operation to get the activity stream ID for the workspace specified by display name. |
| workspaceRemoveMember | Invoke this operation to remove one or more members from the workspace. You need to be the workspace owner or have admin privilege level or have changeWorkspaceOwner system right (only applicable for Public Workspaces) in order to remove a member from a workspace. |
| workspaceSetInfo | Invoke this operation to set information about the specified workspace. |