API Docs for: 0.2.2
Show:

Mc Class

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

Message Center

Constructor

Mc

()

Methods

getThreadByContext

(
  • username
  • jobKey
  • applicationId
  • [context='Interviews']
  • callback
)
async

Get a specific thread by context

Parameters:

  • username String

    Username

  • jobKey String

    Job key

  • applicationId Integer

    Application ID

  • [context='Interviews'] String optional

    Context

  • callback String

    Callback function

getThreadByContextLastPosts

(
  • username
  • jobKey
  • applicationId
  • [context='Interviews']
  • callback
)
async

Get a specific thread by context (last message content)

Parameters:

  • username String

    Username

  • jobKey String

    Job key

  • applicationId Integer

    Application ID

  • [context='Interviews'] String optional

    Context

  • callback String

    Callback function

getThreadDetails

(
  • username
  • threadId
  • callback
)
async

Get thread details

Parameters:

  • username String

    Username

  • threadId Integer

    Thread ID

  • callback String

    Callback function

getTrayByType

(
  • username
  • type
  • callback
)
async

Get tray by type

Parameters:

  • username String

    Username

  • type String

    Tray type/name

  • callback String

    Callback function

getTrays

(
  • callback
)
async

Get trays

Parameters:

  • callback String

    Callback function

markThread

(
  • username
  • threadId
  • params
  • callback
)
async

Update thread based on user actions

Parameters:

  • username String

    Username

  • threadId Integer

    Thread ID

  • params Hash

    Parameters

  • callback String

    Callback function

replyToThread

(
  • username
  • threadId
  • params
  • callback
)
async

Reply to existend thread

Parameters:

  • username String

    Username

  • threadId Integer

    Thread ID

  • params Hash

    Parameters

  • callback String

    Callback function

startNewThread

(
  • username
  • params
  • callback
)
async

Send new message

Parameters:

  • username String

    Username

  • params Hash

    Parameters

  • callback String

    Callback function

Properties

entryPoint

String final static

Default: api