Class: Channel

Channel

new Channel(obj)

A Stream object
Parameters:
Name Type Description
obj Object An object with the Stream properties
Source:

Extends

Members

getObject

Overrides:
Source:

Methods

exportProperties()

Exposes setter and getter for a class from the `data` field
Overrides:
Source:

getClient() → {Client}

Return the client reference
Overrides:
Source:
Returns:
client
Type
Client

getContainer() → {Raptor}

Return the Raptor instance wrapper
Overrides:
Source:
Returns:
container Raptor instance reference
Type
Raptor

parseJSON(raw)

Parse a plain object and populate the corresponding fields in the current instance
Parameters:
Name Type Description
raw Object the json object
Overrides:
Source:

setContainer(container)

Parameters:
Name Type Description
container Raptor reference to Raptor instance wrapper
Overrides:
Source:

setServiceObject(object)

Set a reference to the parent object
Parameters:
Name Type Description
object ServiceObject reference to the parent object
Overrides:
Source:

toJSON() → {Object}

Convert the instance to a js object
Overrides:
Source:
Returns:
Plain js object
Type
Object

toString() → {String}

Return a JSON string of this object
Overrides:
Source:
Returns:
json stringified JSON
Type
String

validate() → {void}

Validate the object and throw an exception if fails
Overrides:
Source:
Returns:
Type
void

Channel

new Channel(obj)

A Stream object
Parameters:
Name Type Description
obj Object An object with the Stream properties
Source:

Extends

Members

getObject

Overrides:
Source:

Methods

exportProperties()

Exposes setter and getter for a class from the `data` field
Overrides:
Source:

getClient() → {Client}

Return the client reference
Overrides:
Source:
Returns:
client
Type
Client

getContainer() → {Raptor}

Return the Raptor instance wrapper
Overrides:
Source:
Returns:
container Raptor instance reference
Type
Raptor

parseJSON(raw)

Parse a plain object and populate the corresponding fields in the current instance
Parameters:
Name Type Description
raw Object the json object
Overrides:
Source:

setContainer(container)

Parameters:
Name Type Description
container Raptor reference to Raptor instance wrapper
Overrides:
Source:

setServiceObject(object)

Set a reference to the parent object
Parameters:
Name Type Description
object ServiceObject reference to the parent object
Overrides:
Source:

toJSON() → {Object}

Convert the instance to a js object
Overrides:
Source:
Returns:
Plain js object
Type
Object

toString() → {String}

Return a JSON string of this object
Overrides:
Source:
Returns:
json stringified JSON
Type
String

validate() → {void}

Validate the object and throw an exception if fails
Overrides:
Source:
Returns:
Type
void