API Docs for:
Show:

Parking Class

Module: astproxy

Abstraction of a parking.

It can throw exception.

Constructor

Parking

(
  • parkingNum
)
Object

Parameters:

  • parkingNum String

    The parking number

Returns:

Object:

The parking object.

Methods

addParkedCaller

(
  • pCall
)

Adds a parked caller.

Parameters:

  • pCall Object

    The parked caller object.

getName

() String

Return the parking name.

Returns:

String:

The parking name.

getParkedCaller

() Object

Returns the parked caller.

Returns:

Object:

The parked caller.

getParking

() String

Return the parking number.

Returns:

String:

The parking number

getTimeout

() Object

Returns the parking timeout.

Returns:

Object:

The timeout of the parking.

removeParkedCaller

()

Remove parked caller.

setName

(
  • pName
)

Set the parking name.

Parameters:

  • pName String

    The parking name

setTimeout

(
  • time
)

Set the parking timeout.

Parameters:

  • time Number

    The timeout of the parking

toJSON

(
  • [privacyStr]
)
Object

Returns the JSON representation of the object.

{
    "name": "71",
    "parking": "71"
    "timeout": 45
    "parkedCaller": { ParkedCaller.toJSON() }
}

Parameters:

  • [privacyStr] String optional

    If it is specified, it hides the last digits of the phone number

Returns:

Object:

The JSON representation of the object.

toString

() String

Return the readable string description of the queue.

Returns:

String:

The readable description of the extension

Properties

name

String private

The parking name.

parkedCaller

Object private

The parked caller. Only one caller at time can be parked in a parking.

parking

String private

The parking number.

timeout

Number private

The timeout of the parking