Class: Chatter

Chatter

new Chatter(conn)

API class for Chatter REST API call
Parameters:
Name Type Description
conn Connection Connection
Source:

Classes

Request
Resource

Methods

batch(callbackopt) → {Promise.<Chatter~BatchRequestResult>}

Make a batch request to chatter API
Parameters:
Name Type Attributes Description
callback Callback.<Chatter~BatchRequestResult> <optional>
 Callback func
Source:
Returns:
Type
Promise.<Chatter~BatchRequestResult>

request(params, callbackopt) → {Chatter~Request}

Make a request for chatter API resource
Parameters:
Name Type Attributes Description
params Chatter~RequestParams Paramters representing HTTP request
callback Callback.<Chatter~RequestResult> <optional>
 Callback func
Source:
Returns:
Type
Chatter~Request

resource(url, queryParamsopt) → {Chatter~Resource}

Make a resource request to chatter API
Parameters:
Name Type Attributes Description
url String Resource URL
queryParams Object <optional>
 Query parameters (in hash object)
Source:
Returns:
Type
Chatter~Resource

Type Definitions

BatchRequestParams

Type:
  • Object
Properties:
Name Type Attributes Description
method String HTTP method
url String Resource URL
richInput String <optional>
 HTTP body (in POST/PUT/PATCH methods)
Source:

BatchRequestResult

Type:
  • Object
Properties:
Name Type Description
hasError Boolean Flag if the batch has one or more errors
results Array.<Object> Batch request results in array
Properties
Name Type Description
statusCode Number HTTP response status code
result Chatter~RequestResult Parsed HTTP response body
Source:

RequestParams

Type:
  • Object
Properties:
Name Type Attributes Description
method String HTTP method
url String Resource URL
body String <optional>
 HTTP body (in POST/PUT/PATCH methods)
Source:

RequestResult

Type:
  • Object
Source: