API Docs for:
Show:

thr0w Class

Defined in: /home/sckmkny/Documents/thr0w-api/index.js:16
Module: thr0w-api

This object provides the base functionality.

Item Index

Methods

Methods

authenticated

() Boolean static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:34

This function returns if authenticated.

Returns:

Boolean:

If authenticated.

connect

(
  • chn
  • connectCallback
  • messageCallback
)
static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:45

This function is used to connect to a channel.

Parameters:

  • chn Integer

    The channel id.

  • connectCallback Function

    The callback function called when connected.

    function()
  • messageCallback Function

    The callback function called for messages.

    function(data)

Parameters:

data Object
The message data.

disconnect

() static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:113

This function disconnects the channel.

getChannel

() Integer static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:128

This function returns the channel number.

Returns:

Integer:

The channel number.

login

(
  • username
  • password
  • callback
)
static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:139

This function logs in a user.

Parameters:

  • username String

    The user's name.

  • password String

    The user's password.

  • callback Function

    The function callback.

    function(error)

Parameters:

error Integer
The error code; null is success.

logout

() static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:216

This function logs out a user.

setBase

(
  • name
)
static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:226

This function is used to set the hostname for the thr0w service.

Parameters:

  • name String

    The hostname.

thr0w

(
  • channels
  • data
)
static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:237

This function is used send messages to channels.

Parameters:

  • channels Array

    Array of Integers; channel ids.

  • data Object

    The message data.

thr0wChannel

(
  • channels
  • data
)
static

Defined in /home/sckmkny/Documents/thr0w-api/index.js:265

This function is used to send messages via the channel.

Parameters:

  • channels Array

    Array of Integers; channel ids.

  • data Object

    The message data.