API Docs for version 1.2.6900

Presence

Module: Circuit

Summary

Data object defining presence and location properties.

Properties

dndUntil

Syntax

dndUntil

Number

Summary

Timestamp up to which the user should remain in DND state.

latitude

Syntax

latitude

Number

Summary

Only available if user has enabled location sharing.

locationText

Syntax

locationText

String

Summary

Reverse lookup matching longitude/latitude. E.g. Tiverton, Ontario, Canada.

longitude

Syntax

longitude

Number

Summary

Only available if user has enabled location sharing.

mobile

Syntax

mobile

Boolean

Summary

True if presence is from a mobile device

poor

Syntax

poor

Boolean

Summary

True if the device has a poor connection

state

Syntax

Summary

Presence state enum value

statusMessage

Syntax

statusMessage

String

Summary

Status message

timeZoneOffset

Syntax

timeZoneOffset

Number

Summary

Timezone offset in minutes. Only available if user has enbled location sharing

userId

Syntax

userId

String

Summary

User ID