Package com.ringcentral.definitions

Class GetPresenceInfo

java.lang.Object

com.ringcentral.definitions.GetPresenceInfo

public class GetPresenceInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
ActiveCallInfo[]	activeCalls	Information on active calls
Boolean	allowSeeMyPresence	If set to `true` - enables other extensions to see the extension presence status
String	callerIdVisibility	Configures the user presence visibility.
String	dndStatus	Extended DnD (Do not Disturb) status.
GetPresenceExtensionInfo	extension
String	meetingStatus	RingCentral Meetings presence Enum: Connected, Disconnected
String	message	Custom status message (as previously published by user)
Boolean	pickUpCallsOnHold	If `true` enables the extension user to pick up a monitored line on hold
String	presenceStatus	Aggregated presence status, calculated from a number of sources Enum: Offline, Busy, Available
Boolean	ringOnMonitoredCall	If `true` enables to ring extension phone, if any user monitored by this extension is ringing
String	telephonyStatus	Telephony presence status Enum: NoCall, CallConnected, Ringing, OnHold, ParkedCall
String	uri	Canonical URI of a presence info resource Format: uri
String	userStatus	User-defined presence status (as previously published by the user) Enum: Offline, Busy, Available

Constructor Summary

Constructors

Constructor	Description
GetPresenceInfo()

Method Summary

Modifier and Type	Method	Description
GetPresenceInfo	activeCalls(ActiveCallInfo[] activeCalls)
GetPresenceInfo	allowSeeMyPresence(Boolean allowSeeMyPresence)
GetPresenceInfo	callerIdVisibility(String callerIdVisibility)
GetPresenceInfo	dndStatus(String dndStatus)
GetPresenceInfo	extension(GetPresenceExtensionInfo extension)
GetPresenceInfo	meetingStatus(String meetingStatus)
GetPresenceInfo	message(String message)
GetPresenceInfo	pickUpCallsOnHold(Boolean pickUpCallsOnHold)
GetPresenceInfo	presenceStatus(String presenceStatus)
GetPresenceInfo	ringOnMonitoredCall(Boolean ringOnMonitoredCall)
GetPresenceInfo	telephonyStatus(String telephonyStatus)
GetPresenceInfo	uri(String uri)
GetPresenceInfo	userStatus(String userStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uri

public String uri

Canonical URI of a presence info resource Format: uri

allowSeeMyPresence

public Boolean allowSeeMyPresence

If set to `true` - enables other extensions to see the extension presence status

callerIdVisibility

public String callerIdVisibility

Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`, the following visibility options are supported via this parameter - All, None, PermittedUsers Enum: All, None, PermittedUsers

dndStatus

public String dndStatus

Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only. Enum: TakeAllCalls, DoNotAcceptAnyCalls, DoNotAcceptDepartmentCalls, TakeDepartmentCallsOnly

extension

public GetPresenceExtensionInfo extension

message

public String message

Custom status message (as previously published by user)

pickUpCallsOnHold

public Boolean pickUpCallsOnHold

If `true` enables the extension user to pick up a monitored line on hold

presenceStatus

public String presenceStatus

Aggregated presence status, calculated from a number of sources Enum: Offline, Busy, Available

ringOnMonitoredCall

public Boolean ringOnMonitoredCall

If `true` enables to ring extension phone, if any user monitored by this extension is ringing

telephonyStatus

public String telephonyStatus

Telephony presence status Enum: NoCall, CallConnected, Ringing, OnHold, ParkedCall

userStatus

public String userStatus

User-defined presence status (as previously published by the user) Enum: Offline, Busy, Available

meetingStatus

public String meetingStatus

RingCentral Meetings presence Enum: Connected, Disconnected

activeCalls

public ActiveCallInfo[] activeCalls

Information on active calls

Constructor Details

GetPresenceInfo

public GetPresenceInfo()

Method Details

uri

public GetPresenceInfo uri(String uri)

allowSeeMyPresence

public GetPresenceInfo allowSeeMyPresence(Boolean allowSeeMyPresence)

callerIdVisibility

public GetPresenceInfo callerIdVisibility(String callerIdVisibility)

dndStatus

public GetPresenceInfo dndStatus(String dndStatus)

extension

public GetPresenceInfo extension(GetPresenceExtensionInfo extension)

message

public GetPresenceInfo message(String message)

pickUpCallsOnHold

public GetPresenceInfo pickUpCallsOnHold(Boolean pickUpCallsOnHold)

presenceStatus

public GetPresenceInfo presenceStatus(String presenceStatus)

ringOnMonitoredCall

public GetPresenceInfo ringOnMonitoredCall(Boolean ringOnMonitoredCall)

telephonyStatus

public GetPresenceInfo telephonyStatus(String telephonyStatus)

userStatus

public GetPresenceInfo userStatus(String userStatus)

meetingStatus

public GetPresenceInfo meetingStatus(String meetingStatus)

activeCalls

public GetPresenceInfo activeCalls(ActiveCallInfo[] activeCalls)