new Chatter(conn)
API class for Chatter REST API call
Parameters:
Name | Type | Description |
---|---|---|
conn |
Connection | Connection |
- Source:
Classes
Methods
-
batch(callback) → {Promise.<Chatter~BatchRequestResult>}
-
Make a batch request to chatter API
Parameters:
Name Type Argument Description callback
Callback.<Chatter~BatchRequestResult> <optional>
Callback func - Source:
Returns:
-
request(params, callback) → {Chatter~Request}
-
Make a request for chatter API resource
Parameters:
Name Type Argument Description params
Chatter~RequestParams Paramters representing HTTP request callback
Callback.<Chatter~RequestResult> <optional>
Callback func - Source:
Returns:
- Type
- Chatter~Request
-
resource(url, queryParams) → {Chatter~Resource}
-
Make a resource request to chatter API
Parameters:
Name Type Argument Description url
String Resource URL queryParams
Object <optional>
Query parameters (in hash object) - Source:
Returns:
- Type
- Chatter~Resource
Type Definitions
-
BatchRequestParams
-
Type:
- Object
- Source:
Properties:
Name Type Argument Description method
String HTTP method url
String Resource URL richInput
String <optional>
HTTP body (in POST/PUT/PATCH methods) -
BatchRequestResult
-
Type:
- Object
- Source:
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 -
RequestParams
-
Type:
- Object
- Source:
Properties:
Name Type Argument Description method
String HTTP method url
String Resource URL body
String <optional>
HTTP body (in POST/PUT/PATCH methods) -
RequestResult
-
Type:
- Object
- Source: