real_time_activity_c

Enumerations

Enumeration Description
XblRealTimeActivityConnectionState Enumeration for the possible connection states of the connection to the real-time activity service.
XblRealTimeActivitySubscriptionState Enumeration for the possible states of a statistic subscription request to the real-time activity service.

Functions

Function Description
XblRealTimeActivityActivate Forces XSAPI to open a WebSocket connection to the Xbox Live real-time activity service. DEPRECATED. Calling this API is no longer required. The WebSocket connection will be made automatically by XSAPI as necessary. This API will be removed in a future release.
XblRealTimeActivityAddConnectionStateChangeHandler Registers a handler function to receive a notification that is sent when the client service loses or gains connectivity to the real time activity service.
XblRealTimeActivityAddResyncHandler Registers a handler function to receive a notification that is sent when there is a resync message from the real time activity service.
XblRealTimeActivityConnectionStateChangeHandler Handler function for when the client service loses or gains connectivity to the real time activity service.
XblRealTimeActivityDeactivate Indicates that a client real-time activity session is complete. If there are no remaining real-time service activations, the WebSocket connection will be cleaned up along with remaining subscriptions. DEPRECATED. Calling this API is no longer required. The WebSocket connection will be cleaned up automatically by XSAPI when it is no longer needed. This API will be removed in a future release.
XblRealTimeActivityRemoveConnectionStateChangeHandler Unregisters an event handler for real time activity connectivity state changes.
XblRealTimeActivityRemoveResyncHandler Unregisters an event handler for real time activity resync notifications.
XblRealTimeActivityRemoveSubscriptionErrorHandler Unregisters an event handler for real time activity error notifications. DEPRECATED. RTA service errors will now be handled by XSAPI internally and callback will no longer be invoked.
XblRealTimeActivityResyncHandler Handler function for when there is a resync message from the real time activity service.
XblRealTimeActivitySubscriptionErrorHandler Handler function for when there is an error in the real time activity service.
XblRealTimeActivitySubscriptionGetId Get the unique ID for the subscription. DEPRECATED. The state of RTA subscriptions is no longer exposed publicly. This API will return a unique client side ID, but it is in no way related to the ID assigned by the RTA service.
XblRealTimeActivitySubscriptionGetState Get the state of the subscription. DEPRECATED. The state of RTA subscriptions is no longer exposed publicly. XblRealTimeActivitySubscriptionState::Unknown will always be returned.

Handles

Handle Description
XblRealTimeActivitySubscriptionHandle Subscription handle.