Device

This object serves as a collection of APIs for accessing related devices such as the Dolby Conference Phone.

Example:

dapi.device.phone.reboot();

Member Summary

Public Members

Returns the status of the most recent request to upload logs.

Provides access to a DevicePhone object which holds APIs related to a paired Dolby Conference Phone.

Method Summary

Public Methods

Allows being notified of when the status of the most recent logs-upload request has changed.

uploadLogs(url: string, type: string)

Starts uploading the device's logs.

Public Members

public lastLogsUploadStatus: string source

Returns the status of the most recent request to upload logs.

Possible values are:

  • "IN_PROGRESS": Waiting for the logs-upload to finish.
  • "SUCCESS": The request finished successfully.
  • "FAILED": The request failed to complete.

public phone: Phone source

Provides access to a DevicePhone object which holds APIs related to a paired Dolby Conference Phone.

Public Methods

public lastLogsUploadStatusChanged(newStatus: string) source

Allows being notified of when the status of the most recent logs-upload request has changed.

Params:

NameTypeAttributeDescription
newStatus string

the new state of the logs-upload request.

  • "IN_PROGRESS": Waiting for the logs-upload to finish.
  • "SUCCESS": The request finished successfully.
  • "FAILED": The request failed to complete.

Example:

dapi.device.lastLogsUploadStatusChanged.connect(myLogsStatusHandlerFunction);

public uploadLogs(url: string, type: string) source

Starts uploading the device's logs.

Params:

NameTypeAttributeDescription
url string

target address where the logs will be uploaded to

type string

specifies the kind of logs to upload:

  • "FULL": Upload maximum log information.
  • "EVENTS_ONLY": Only upload text log events.
  • "CALL_STATS": Upload call statistics.

Example:

dapi.device.uploadLogs("http://mywebserver.net/myupload", "FULL");