Class: Resource

Chatter~ Resource

<protected> new Resource(chatter, url, queryParams)

A class representing chatter API resource
Parameters:
Name Type Argument Description
chatter Chatter Chatter API object
url String Resource URL
queryParams Object <optional>
 Query parameters (in hash object)
Source:

Extends

Methods

batchParams() → {Chatter~BatchRequestParams}

Retrieve parameters in batch request form
Inherited From:
Source:
Returns:
Type
Chatter~BatchRequestParams

create(data, callback) → {Chatter~Request}

Create a new resource
Parameters:
Name Type Argument Description
data Object Data to newly post
callback Callback.<Chatter~RequestResult> <optional>
 Callback function
Source:
Returns:
Type
Chatter~Request

del(callback) → {Chatter~Request}

Synonym of Resource#delete()
Parameters:
Name Type Argument Description
callback Callback.<Chatter~RequestResult> <optional>
 Callback function
Source:
Returns:
Type
Chatter~Request

delete(callback) → {Chatter~Request}

Delete specified resource
Parameters:
Name Type Argument Description
callback Callback.<Chatter~RequestResult> <optional>
 Callback function
Source:
Returns:
Type
Chatter~Request

promise() → {Promise.<Chatter~RequestResult>}

Retrieve parameters in batch request form
Inherited From:
Source:
Returns:
Type
Promise.<Chatter~RequestResult>

retrieve(callback) → {Chatter~Request}

Retrieve resource content
Parameters:
Name Type Argument Description
callback Callback.<Chatter~RequestResult> <optional>
 Callback function
Source:
Returns:
Type
Chatter~Request

stream() → {stream.Stream}

Returns Node.js Stream object for request
Inherited From:
Source:
Returns:
Type
stream.Stream

then()

Promise/A+ interface http://promises-aplus.github.io/promises-spec/ Delegate to deferred promise, return promise instance for batch result
Inherited From:
Source:

thenCall()

Promise/A+ extension Call "then" using given node-style callback function
Inherited From:
Source:

update(data, callback) → {Chatter~Request}

Update specified resource
Parameters:
Name Type Argument Description
data Obejct Data to update
callback Callback.<Chatter~RequestResult> <optional>
 Callback function
Source:
Returns:
Type
Chatter~Request