static osapi.jive.corev3.dms

Static class for creating and getting DirectMessages.

Methods

↑
create(dm,options)
POST /dms

Retrieves

DirectMessage

Description

Create a new direct message, and return a DirectMessage representing the new object. You must submit a JSON object that contains the following fields:

     {
         "content" : {
             "type" : "text/html",
             "text" : "{text}"
         },
         "participants" : [
             "{participantURI}", ...
         ]
     }

where:

  • {text} - Text of the direct message.
  • {participantURI} - Absolute or partial (/people/####) URI for a Jive person that this message will be sent to.
Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • DirectMessage describing the newly created direct message
    • ↑
    get(options)
    GET /dms/{uri}

    Retrieves

    DirectMessage

    Description

    Return the specified direct message by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the requested direct message
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • DirectMessage describing the specified direct message
    • ↑
    subject(dm,options)
    POST /dms/{dmID}/subject

    Retrieves

    DirectMessage

    Description