osapi.jive.corev3.communications.interaction
Properties
Methods
Resources
Properties
Property | Type | Mode † | Description |
---|---|---|---|
| Person | read-only | ↑ Author of this content object. |
content | ContentBody | required | ↑ Content of this content object. |
contentID | String | read-only | ↑ Internal Jive ID associated with the content. |
contentImages | Image[] | read-only | ↑ |
contentVideos | Object[] | read-only | ↑ |
followerCount | Integer | read-only | ↑ Number of people following this object. Availability:Will be present only for object types that support being followed. |
highlightBody | String | read-only | ↑ Highlight snippet of a search match in the body or description. Availability:Will be present in search results only. |
highlightSubject | String | read-only | ↑ Highlight snippet of a search match in the subject or name. Availability:Will be present in search results only. |
highlightTags | String | read-only | ↑ Highlight snippet of a search match in tags. Availability:Will be present in search results only. |
iconCss | String | read-only | ↑ CSS Style to locate icon within sprite. |
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. |
likeCount | Integer | read-only | ↑ Number of people who have liked this object. Availability:Will be present only for object types that support being liked. |
parent | String | required | ↑ URI of the parent place (or person, for personal content) of this content object. |
parentContent | Summary | read-only | ↑ Summary information about the content object that is the parent of this object. Availability:Will be present in search results only. |
parentPlace | Summary | read-only | ↑ Summary information about the place that contains this object. Availability:Will be present in search results only. |
published | ISO 8601 Date | read-only | ↑ Date and time when this content object was originally created. |
publishedCalendarDate | String | read-only | ↑ |
publishedTime | String | read-only | ↑ |
replyCount | Integer | read-only | ↑ Number of replies to this object. Availability:Will be present only for object types that support replies. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
status | String | read-only | ↑ Published status of this content object.
|
subject | String | required | ↑ Subject of this content object. |
| String[] | optional | ↑ Tags associated with this object. Availability:Will be present only for object types that support tags |
type | String | required | ↑ The object type for this object ("comment"). This field is required when creating new content. |
updated | ISO 8601 Date | read-only | ↑ Date and time this content object was most recently updated. |
viewCount | Integer | read-only | ↑ Number of times this content object has been viewed. Availability:Will be present only for objects that support view counts |
visibleToExternalContributors | Boolean | read-only | ↑ Flag indicating that this content object is potentially visible to external contributors. |
Methods
addParticipant(object,options)
POST /collaborations/1234/participants
Retrieves
Object
Description
Add a new participant to this Collaboration.
POST /contents/1234/comments
(comment,options)Retrieves
Comment
Description
Add a comment about this content object.
The minimum JSON object needed to create a comment is:
{ "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"}, }
Takes:
- Comment describing the new comment
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | The names of the fields to be returned |
Retrieves:
createExtProps(extprop,options)
POST /contents/1234/extprops
Retrieves
ExtProps[]
Description
Creates extended properties for content.
{ "any prop name": "any val", "any prop2 name": "any val" }
Availability:
Content should be editable to caller.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
Retrieves:
createInteraction(interaction,options)
POST /collaborations/1234/interactions
Retrieves
Interaction
Description
Create a new interaction on this collaboration, and return a interaction representing the new object.
Takes:
- interaction fields describing the new interaction
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | The names of the fields to be returned |
Retrieves:
createOutcome(outcome,options)
POST /contents/1234/outcomes
Retrieves
Outcome
Description
Register that the requesting person created the outcome.
Here is an example of a JSON with the minimum set of fields you must include:
{ "outcomeType": { "id": 1 } }
Availability:
Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already
Takes:
- Outcome the outcome to be created.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned. |
Retrieves:
deleteExtProps()
DELETE /contents/1234/extprops
Retrieves
--
Description
Deletes all extended properties for content.
Availability:
Content should be editable to caller.
destroy()
DELETE /contents/1234
Retrieves
--
Description
Delete this content object and any related comments and other related information.
get(options)
GET /collaborations/1234
Retrieves
Collaboration
Description
Return an updated version of this collaboration.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | The names of the fields to be returned |
Retrieves:
getChildOutcomeTypes(options)
GET /contents/1234/childOutcomeTypes
Retrieves
OutcomeType[]
Description
Return a paginated list of possible outcomes types on the content object's children.
Options:
Name | Type | Required | Description |
---|---|---|---|
count | Integer | false | The maximum number of outcome types to return (default is 25) |
fields | String | false | The names of the fields to be returned |
startIndex | Integer | false | Zero-relative index of the first person to return (default is 0) |
Retrieves:
GET /contents/1234/comments
(options)Retrieves
Comment[]
Description
Return a paginated list of the comments about this content object.
Options:
Name | Type | Required | Description |
---|---|---|---|
outcomeType | String | false | The type name of outcomes to filter by. |
count | Integer | false | The maximum number of comments to be returned (default is 25) |
anchor | String | false | optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned. |
excludeReplies | Boolean | false | Flag indicating that replies to the direct comments about this direct message should be excluded (default is false) |
fields | String | false | The names of the fields to be returned |
hierarchical | Boolean | false | Flag indicating that comments should be returned in hierarchical order instead of chronological order (default is true) |
startIndex | Integer | false | Zero-relative index of the first comment to be returned (default is zero) |
Retrieves:
getExtProps(options)
GET /contents/1234/extprops
Retrieves
ExtProps
Description
Returns extended properties for content.
Availability:
Content should be visible to caller.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
Retrieves:
getInteractions(options)
GET /collaborations/1234/interactions
Retrieves
Object
Description
Returns interactions for this collaborationgetOutcomes(options)
GET /contents/1234/outcomes
Retrieves
Outcome[]
Description
Return a paginated list of outcomes on the content.
Options:
Name | Type | Required | Description |
---|---|---|---|
count | Integer | false | The maximum number of outcomes to return (default is 25) |
fields | String | false | The names of the fields to be returned |
startIndex | Integer | false | Zero-relative index of the first person to return (default is 0) |
Retrieves:
getOutcomeTypes(options)
GET /contents/1234/outcomeTypes
Retrieves
OutcomeType[]
Description
Return a paginated list of possible outcomes types on the content.
Options:
Name | Type | Required | Description |
---|---|---|---|
count | Integer | false | The maximum number of outcome types to return (default is 25) |
fields | String | false | The names of the fields to be returned |
startIndex | Integer | false | Zero-relative index of the first person to return (default is 0) |
Retrieves:
setSubject(collaboration,options)
POST /collaborations/1234/subject
Retrieves
Collaboration
Description
Sets the subject of this Collaboration.
Takes:
- Collaboration fields (or just the subject field) with the modified subject
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | The names of the fields to be returned |
Retrieves:
toURI()
Retrieves
String
Description
Retrieves:
Resources
Resource | Method | Returns | Description |
---|---|---|---|
html | GET | Object | ↑ Return the HTML representation of this collaboration. |