Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Contains information about a user's presence, including their availability and user activity.
Note: This resource is currently only supported for Microsoft Teams users.
This resource supports subscribing to change notifications.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get presence | presence | Get a user's presence information. |
| Get presence for multiple users | presence collection | Get the presence information for multiple users. |
| Set presence | Set an application's presence session for a user. | |
| Clear presence | Clear an application's presence session for a user. | |
| Set user preferred presence | Set the preferred availability and activity status for a user. | |
| Clear user preferred presence | Clear the preferred availability and activity status for a user. | |
| Set user status message | Set a presence status message for a user. |
Properties
| Property | Type | Description |
|---|---|---|
| activity | String collection | The supplemental information to a user's availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly. |
| availability | String collection | The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown |
| id | String | The unique identifier for the user. |
| statusMessage | presenceStatusMessage | The presence status message of a user. |
Note: To learn more about the different presence states, see User presence in Teams.
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"activity": "String",
"availability":"String",
"id": "String (identifier)",
"statusMessage":{"@odata.type": "#microsoft.graph.presenceStatusMessage"}
}