osapi.jive.corev3.communications.Mention
A Mention is a linked reference (created by using an "@" in the text editor) to a specific context object.
Methods
Properties
| Property | Type | Mode † | Description |
|---|---|---|---|
id | String | read-only | ↑ Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs. |
mentionedContent | Content | read-only | ↑ The content object that contained the mention. |
mentionedObject | Object | read-only | ↑ The object that was mentioned. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
type | String | read-only | ↑ The object type of this object ("mention"). |
Methods
↑
Mention describing the updated mention
get(options)
GET /mentions/1234Retrieves
MentionDescription
Return an updated version of this mention.
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Names of the fields to be returned |
Retrieves:
↑
markRead()
POST /mentions/1234/readRetrieves
--Description
Mark this mention as having been read.
Since: 3.2
↑
markUnread()
DELETE /mentions/1234/readRetrieves
--Description
Mark this mention as having been read.