Default implementation of ShareableItemEvent, used by apps to report a user achievement worth posting to the social wall. An app builds one of these with the achieving profile, a description of what happened, the app's own name and the id of the related activity, and fires it so that a listener can post it to the social wall and drive journeys, automations and event listeners.
Implements: ShareableItemEvent
Properties
| Property | Returns | Description |
|---|---|---|
| contentIds | List<String> | The ids of the content items (walls) this event should be posted to. Empty if none were supplied, in which case a listener typically falls back to posting on the team org wall. |
| itemDescription | String | A textual description of what happened, eg "Completed module ABC". |
| relatedAppName | String | The name of the app which owns the source activity and can locate it. |
| relatedId | String | The id of the source activity within the related app, eg the module status id for an elearning completion. May be numeric or a plain string. |
| shareable | boolean | Whether this event actually represents an achievement worth sharing. Always true for this implementation. |
| shareableItemWebsite | Website | The website this shareable item should be associated with. |
| sourceProfile | Profile | The user who should be recognised for this activity. |
Methods
isShareable()
Returns: boolean
Whether this event actually represents an achievement worth sharing. Always true for this implementation.
getSourceProfile()
Returns: Profile
The user who should be recognised for this activity.
getItemDescription()
Returns: String
A textual description of what happened, eg "Completed module ABC".
getRelatedAppName()
Returns: String
The name of the app which owns the source activity and can locate it.
getRelatedId()
Returns: String
The id of the source activity within the related app, eg the module status id for an elearning completion. May be numeric or a plain string.
getContentIds()
Returns: List<String>
The ids of the content items (walls) this event should be posted to. Empty if none were supplied, in which case a listener typically falls back to posting on the team org wall.
getShareableItemWebsite()
Returns: Website
The website this shareable item should be associated with.