API reference

GroupPresenceStatusCode Enum

GroupPresenceStatusCode represents the set of status codes returned by the grouppresence API.

Signature

enum GroupPresenceStatusCode : Enum<GroupPresenceStatusCode>

Enumeration Constants

Member	Description
Success	The operation completed successfully. This is a common status code. It can be returned by any Platform SDK method.
InternalError	An internal error occurred. This is a common status code. It can be returned by any Platform SDK method.
NotInitialized	The platform is not initialized. This is a common status code. It can be returned by any Platform SDK method.
EntitlementFailure	Entitlement check failed. This is a common status code. It can be returned by any Platform SDK method.
RateLimitExceeded	Rate limit exceeded. This is a common status code. It can be returned by any Platform SDK method.
Forbidden	Feature is disabled for the current user. This is a common status code. It can be returned by any Platform SDK method.
NetworkUnavailable	No network connection available. This is a common status code. It can be returned by any Platform SDK method.
ProviderUnknownError	Unknown error. This is a common status code. It can be returned by any Platform SDK method.
ProviderFeatureNotEnabled	Feature is disabled for the current user. This is a common status code. It can be returned by any Platform SDK method.
ProviderOperationNotSupported	Operation is not supported. This is a common status code. It can be returned by any Platform SDK method.
ProviderInitializationFailed	Failed to initialize provider. This is a common status code. It can be returned by any Platform SDK method.
ProviderGraphApiError	Graph API error. This is a common status code. It can be returned by any Platform SDK method.
LoggedInUserManagerBuildPresenceError	Logged in user manager build presence error. This error occurs when there is a failure building presence data for the logged-in user.
OvrServiceError	OVR service error. This error occurs when there is a general error communicating with the OVR service.
OvrServiceUnknownError	OVR service unknown error. This error occurs when an unknown error happens while communicating with the OVR service.
ClientUsageError	Client usage error that can occur when setting presence. Possible reasons include: - App not registered: An unregistered process attempted to set presence. - App ID not found: Unable to resolve app ID for the calling package. Ensure the app is registered and the package name is valid. - Not foreground app: The calling app is a 2D app or does not match the current foreground app ID. - Heartbeat invalid parameters: The heartbeat failed due to invalid presence options parameters. Check the error message for specific details about the failure.
SetUnknownError	Set unknown error. This error occurs when an unknown error happens during a set operation.
PresenceApiUnavailable	Presence API unavailable error. This error occurs when the presence API is not available.
SetDeeplinkMessageOverrideUnknownError	Set deeplink message override unknown error. This error occurs when an unknown error happens while setting the deeplink message override.
SetDestinationUnknownError	Set destination unknown error. This error occurs when an unknown error happens while setting destination data.
SetIsJoinableUnknownError	Set is joinable unknown error. This error occurs when an unknown error happens while setting the joinable state.
SetLobbySessionUnknownError	Set lobby session unknown error. This error occurs when an unknown error happens while setting the lobby session.
SetMatchSessionUnknownError	Set match session unknown error. This error occurs when an unknown error happens while setting the match session.
LaunchRosterPanelUnknownError	Launch roster panel unknown error. This error occurs when an unknown error happens while launching the roster panel.
LaunchRosterPanelPayloadError	Launch roster panel payload error. This error occurs when there is an error with the payload for launching the roster panel.
LaunchDeeplinkIntentError	Launch deeplink intent error. This error occurs when there is an error launching the deeplink intent.
LaunchRosterPanelRetrievePresenceError	Launch roster panel retrieve presence error. This error occurs when there is an error retrieving presence data for the roster panel.
LaunchRosterPanelClientUsageError	Launch roster panel client usage error. This error occurs when there is a client usage error while launching the roster panel.
LaunchMultiplayerErrorDialogUnknownError	Launch multiplayer error dialog unknown error. This error occurs when an unknown error happens while launching the multiplayer error dialog.
LaunchInvitePanelUnknownError	Launch invite panel unknown error. This error occurs when an unknown error happens while launching the invite panel.
LaunchInvitePanelPayloadError	Launch invite panel payload error. This error occurs when there is an error with the payload for launching the invite panel.
LaunchInvitePanelRetrievePresenceError	Launch invite panel retrieve presence error. This error occurs when there is an error retrieving presence data for the invite panel.
LaunchInvitePanelClientUsageError	Launch invite panel client usage error. This error occurs when there is a client usage error while launching the invite panel.
LaunchInvitePanelTravelInviteActivityNotFoundError	Launch invite panel travel invite activity not found error. This error occurs when the travel invite activity is not found for the invite panel.
LaunchInvitePanelTravelInviteActivityLaunchError	Launch invite panel travel invite activity launch error. This error occurs when there is an error launching the travel invite activity for the invite panel.
LaunchRejoinDialogUnknownError	Launch rejoin dialog unknown error. This error occurs when an unknown error happens while launching the rejoin dialog.
LaunchRejoinDialogClientUsageError	Launch rejoin dialog client usage error. This error occurs when there is a client usage error while launching the rejoin dialog.
SetRichPresenceUnknownError	Set rich presence unknown error. This error occurs when an unknown error happens while setting rich presence.
SetRichPresenceNotConnected	Set rich presence not connected error. This error occurs when the service is not connected while attempting to set rich presence.
SetRichPresenceInvalidInput	Set rich presence invalid input error. This error occurs when invalid input is provided while setting rich presence.
SetRichPresenceSerializationError	Set rich presence serialization error. This error occurs when there is a serialization error while setting rich presence.
SetRichPresenceServerError	Set rich presence server error. This error occurs when there is a server error while setting rich presence.
SetRichPresenceTimeout	Set rich presence timeout error. This error occurs when a timeout happens while setting rich presence.
SetRichPresenceCancelled	Set rich presence cancelled error. This error occurs when the operation is cancelled while setting rich presence.
SetRichPresenceGraphqlTimeout	Set rich presence GraphQL timeout error. This error occurs when a GraphQL timeout happens while setting rich presence.
SetRichPresenceGraphqlExecutionException	Set rich presence GraphQL execution exception error. This error occurs when a GraphQL execution exception happens while setting rich presence.
SetRichPresenceInterruptedException	Set rich presence interrupted exception error. This error occurs when an interrupted exception happens while setting rich presence.
SetRichPresencePreferencesManagerNull	Set rich presence preferences manager null error. This error occurs when the preferences manager is null while setting rich presence.
SetRichPresencePushTokenNull	Set rich presence push token null error. This error occurs when the push token is null while setting rich presence.
SetRichPresenceHeartbeatDisabled	Set rich presence heartbeat disabled error. This error occurs when heartbeat is disabled while setting rich presence.