Home Reference Source Test Repository
public class | source

CiscoSpark

Cisco Spark API Abstract Class

Test:

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 constructor(accessToken: string, userAgent: string, apiUrl: string) source

Constructor for abstract class

Params:

NameTypeAttributeDescription
accessToken string
  • nullable: true

Your Cisco Spark accesstoken

userAgent string
  • nullable: true

User Agent request header

apiUrl string
  • nullable: true

API Url

Public Members

public set requestCallback: requestCallback source

Protected Members

protected accessToken: string source

protected apiUrl: string source

protected idName: string source

protected userAgent: string source

Public Methods

public abstract checkId(id: string): boolean source

Check Id

Params:

NameTypeAttributeDescription
id string

Id string to be checked

Return:

boolean

Is Id valid?

public create(params: Object, callback: requestCallback): * source

Create an object

Params:

NameTypeAttributeDescription
params Object

Parameters of request

callback requestCallback

Return:

*

Test:

public list(params: Object, callback: requestCallback) source

List objects

Params:

NameTypeAttributeDescription
params Object

Parameters of request

callback requestCallback

Test:

Protected Methods

protected request(options: Object, callback: requestCallback): * source

Make a request

Params:

NameTypeAttributeDescription
options Object

Options for Request

callback requestCallback

Callback

Return:

*

Test: