CiscoSpark
Direct Subclass:
Cisco Spark API Abstract Class
Constructor Summary
Public Constructor | ||
public |
constructor(accessToken: string, userAgent: string, apiUrl: string) Constructor for abstract class |
Member Summary
Public Members | ||
public set |
|
Protected Members | ||
protected |
|
|
protected |
|
|
protected |
|
|
protected |
|
Method Summary
Public Methods | ||
public abstract |
Check Id |
|
public |
create(params: Object, callback: requestCallback): * Create an object |
|
public |
delete(id: string, callback: requestCallback): * Delete an Object |
|
public |
get(id: string, callback: requestCallback): * Get an object |
|
public |
list(params: Object, callback: requestCallback) List objects |
|
public |
update(id: string, params: Object, callback: requestCallback): * Update an object |
Protected Methods | ||
protected |
request(options: Object, callback: requestCallback): * Make a request |
Public Constructors
Public Methods
public abstract checkId(id: string): boolean source
Check Id
Params:
Name | Type | Attribute | Description |
id | string | Id string to be checked |
public create(params: Object, callback: requestCallback): * source
Create an object
Params:
Name | Type | Attribute | Description |
params | Object | Parameters of request |
|
callback | requestCallback |
Return:
* |
public delete(id: string, callback: requestCallback): * source
Delete an Object
Params:
Name | Type | Attribute | Description |
id | string | Id of the object |
|
callback | requestCallback |
Return:
* |
Test:
public get(id: string, callback: requestCallback): * source
Get an object
Params:
Name | Type | Attribute | Description |
id | string | Id of the object |
|
callback | requestCallback |
Return:
* |
public list(params: Object, callback: requestCallback) source
List objects
Params:
Name | Type | Attribute | Description |
params | Object | Parameters of request |
|
callback | requestCallback |
public update(id: string, params: Object, callback: requestCallback): * source
Update an object
Params:
Name | Type | Attribute | Description |
id | string | Id of the object |
|
params | Object | Parameters of request |
|
callback | requestCallback |
Return:
* |
Test:
- CiscoSpark.people should update a Person Details
- CiscoSpark.rooms should update a Room Details
- CiscoSpark.teamMemberships should update Team Membership Details
- CiscoSpark.teams should update Team Details
- CiscoSpark.webhooks should update Team Details
- CiscoSpark.memberships should update Team Membership Details
Protected Methods
protected request(options: Object, callback: requestCallback): * source
Make a request
Params:
Name | Type | Attribute | Description |
options | Object | Options for Request |
|
callback | requestCallback | Callback |
Return:
* |