API Docs for: 2.0.0
Show:

Messages Class

Defined in: lib/routers/messages.js:24
Module: routes.messages

Messages

Constructor

Messages

()

Defined in lib/routers/messages.js:24

Methods

createRoom

(
  • company
  • params
  • callback
)
async

Defined in lib/routers/messages.js:129

Create a new room

Parameters:

  • company String

    Company ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRoomByApplication

(
  • company
  • applicationId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:97

Get a specific room by application ID

Parameters:

  • company String

    Company ID

  • applicationId Integer

    Application ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRoomByContract

(
  • company
  • contractId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:113

Get a specific room by contract ID

Parameters:

  • company String

    Company ID

  • contractId Integer

    Contract ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRoomByOffer

(
  • company
  • offerId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:81

Get a specific room by offer ID

Parameters:

  • company String

    Company ID

  • offerId Integer

    Offer ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRoomDetails

(
  • company
  • roomId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:49

Get a specific room information

Parameters:

  • company String

    Company ID

  • roomId String

    Room ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRoomMessages

(
  • company
  • roomId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:65

Get messages from a specific room

Parameters:

  • company String

    Company ID

  • roomId String

    Room ID

  • params Hash

    Parameters

  • callback String

    Callback function

getRooms

(
  • company
  • params
  • callback
)
async

Defined in lib/routers/messages.js:35

Retrieve rooms information

Parameters:

  • company String

    Company ID

  • params Hash

    Parameters

  • callback String

    Callback function

sendMessageToRoom

(
  • company
  • roomId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:144

Send a message to a room

Parameters:

  • company String

    Company ID

  • roomId String

    Room ID

  • params Hash

    Parameters

  • callback String

    Callback function

sendMessageToRooms

(
  • company
  • params
  • callback
)
async

Defined in lib/routers/messages.js:160

Send a message to a batch of rooms

Parameters:

  • company String

    Company ID

  • params Hash

    Parameters

  • callback String

    Callback function

updateRoomMetadata

(
  • company
  • roomId
  • params
  • callback
)
async

Defined in lib/routers/messages.js:192

Update the metadata of a room

Parameters:

  • company String

    Company ID

  • roomId String

    Room ID

  • params Hash

    Parameters

  • callback String

    Callback function

updateRoomSettings

(
  • company
  • roomId
  • username
  • params
  • callback
)
async

Defined in lib/routers/messages.js:175

Update a room settings

Parameters:

  • company String

    Company ID

  • roomId String

    Room ID

  • username String

    User ID

  • params Hash

    Parameters

  • callback String

    Callback function

Properties

entryPoint

String final static

Defined in lib/routers/messages.js:15

Default: api