API Docs for: 2.6
Show:

QueueMember Class

Module: ast_proxy

Abstraction of a queue member.

It can throw exception.

Constructor

QueueMember

(
  • memberNum
  • queueId
  • pausedValue
  • loggedIn
)
Object

Parameters:

  • memberNum String

    The member number

  • queueId String

    The name of the queue membership

  • pausedValue Boolean

    True if the extension is paused from the queue

  • loggedIn Boolean

    True if the extension is logged in the queue

Returns:

Object:

The queue member object.

Methods

getCallsTakenCount

() Number

Return the number of the taken calls.

Returns:

Number:

The number of the taken calls.

getLastCallTimestamp

() Number

Return the timestamp of the last taken call.

Returns:

Number:

The timestamp of the last taken call.

getMember

() String

Return the member number.

Returns:

String:

The member number

getName

() String

Return the member name.

Returns:

String:

The member name.

getQueue

() String

Return the name of the queue membership.

Returns:

String:

The name of the queue membership.

getType

() String

Return the type of the member.

Returns:

String:

The type of the member.

isDynamic

() Boolean

Checks if the member is dynamic.

Returns:

Boolean:

True if the member is dynamic.

isLoggedIn

() Boolean

Checks the logged in status of the member.

It can throw an Exception.

Returns:

Boolean:

True if the member is logged into the queue

setCallsTakenCount

(
  • num
)

Set the number of the taken calls.

It can throw an Exception.

Parameters:

  • num Number

    The number of the taken calls.

setLastCallTimestamp

(
  • num
)

Set the timestamp of the last taken call.

It can throw an Exception.

Parameters:

  • num Number

    The timestamp number.

setLastPausedInData

(
  • timestamp
  • reason
)

Set the timestamp and the reason of the last started pause.

It can throw an Exception.

Parameters:

  • timestamp Number

    The timestamp number

  • reason String

    The reason descripion

setLastPausedOutData

(
  • timestamp
)

Set the timestamp of the last ended pause.

It can throw an Exception.

Parameters:

  • timestamp Number

    The timestamp number

setLoggedIn

(
  • value
)

Set the logged in status of the member.

It can throw an Exception.

Parameters:

  • value Boolean

    True if the member is logged in the queue

setName

(
  • memberName
)

Set the member name.

Parameters:

  • memberName String

    The member name

setPaused

(
  • value
  • reason
)

Sets the paused status of the member. If the pause has been started a reason description is needed. It updates the lastPausedInTimestamp or lastPausedOutTimestamp property consequently.

It can throw an Exception.

Parameters:

  • value Boolean

    True if the pause has been started, false if it has been stopped.

  • reason String

    The reason description of the started pause

setType

(
  • value
)

Set the member type.

Parameters:

  • value String

    The member type

toJSON

() Object

Returns the JSON representation of the object.

{
    type:                   "static",
    name:                   "Name",
    queue:                  "401",
    member:                 "214",
    paused:                 true,          // the paused status
    loggedIn:               true,          // if the member is logged in or not
    callsTakenCount:        0,             // the number of taken calls
    lastCallTimestamp:      1365590191     // the timestamp of the last taken call
    lastPausedInReason:     "some reason"  // the reason description of the last started pause
    lastPausedInTimestamp:  1365591191     // the timestamp of the last started pause
    lastPausedOutTimestamp: 1365594191     // the timestamp of the last ended pause
}

Returns:

Object:

The JSON representation of the object.

toString

() String

Return the readable string description of the member.

Returns:

String:

The readable description of the extension

Properties

callsTakenCount

Number private

The number of the taken calls.

Default: 0

lastCallTimestamp

Number private

The timestamp of the last taken call.

Default: 0

lastPausedInReason

String private

The reason of the last started pause.

Default: ""

lastPausedInTimestamp

Number private

The timestamp of the last started pause.

Default: 0

lastPausedOutTimestamp

Number private

The timestamp of the last ended pause.

Default: 0

loggedIn

Boolean private

The logged in status of the member.

member

String private

The member number.

name

String private

The member name.

paused

Boolean private

The pause status of the member.

queue

String private

The identifier of queue membership.

QUEUE_MEMBER_STATUS_ENUM

Object final

The QueueMember status enumeration. It's the same of private STATUS_ENUM.

Default: Equal to the private property STATUS_ENUM

QUEUE_MEMBER_TYPES_ENUM

Object final

The QueueMember types enumeration. It's the same of the private TYPES_ENUM.

Default: Equal to the private property TYPES_ENUM

STATUS_ENUM

Object private final

The QueueMember status enumeration.

Default: { "FREE": "free", "BUSY": "busy" }

type

String private

The member typology.

TYPES_ENUM

Object private final

The queue member types enumeration.

Default: { STATIC: "static", DYNAMIC: "dynamic", REALTIME: "realtime" }