Functions
| Function | Description |
|---|---|
| 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 (RTA) service. |
| XblRealTimeActivityAddResyncHandler | Registers a handler function to receive a notification that is sent when there is a resync message from the RTA service. |
| XblRealTimeActivityConnectionStateChangeHandler | Handler function for when the client service loses or gains connectivity to the RTA service. |
| XblRealTimeActivityRemoveConnectionStateChangeHandler | Unregisters an event handler for RTA service connectivity state changes. |
| XblRealTimeActivityRemoveResyncHandler | Unregisters an event handler for RTA service resync notifications. |
| XblRealTimeActivityResyncHandler | Handler function for when there is a resync message from the RTA service. |
| XblRealTimeActivitySubscriptionErrorHandler | Deprecated. XSAPI no longer invokes this callback. |
Handles
| Handle | Description |
|---|---|
| XblRealTimeActivitySubscriptionHandle | Subscription handle. |
Enumerations
| Enumeration | Description |
|---|---|
| XblRealTimeActivityConnectionState | Enumeration for the possible connection states of the connection to the RTA service. |
| XblRealTimeActivitySubscriptionState | Enumeration for the possible states of a statistic subscription request to the RTA service. |
Deprecated functions
The following functions are declared inreal_time_activity_c.h but are deprecated. Don’t call them in new code. The XBOX services API (XSAPI) manages the Real-Time Activity (RTA) service connection for you and handles RTA service errors internally.
| Function | Current behavior | What to do instead |
|---|---|---|
XblRealTimeActivityActivate | Adds a legacy activation for the user and tries to establish the RTA service connection. Returns S_OK. | Don’t call it. XSAPI connects automatically when you register handlers and track items that use RTA. |
XblRealTimeActivityDeactivate | Removes a legacy activation for the user. When no activations remain, XSAPI might close the connection and call connection state change handlers with XblRealTimeActivityConnectionState::Disconnected. | Don’t call it. XSAPI closes the connection when it’s no longer needed. |
XblRealTimeActivityAddSubscriptionErrorHandler | Does nothing. XSAPI never calls the handler. | Don’t register a handler. |
XblRealTimeActivityRemoveSubscriptionErrorHandler | Does nothing and returns S_OK. | Remove the call. |
XblRealTimeActivitySubscriptionGetState | On success, writes XblRealTimeActivitySubscriptionState::Unknown to state and returns S_OK. | Don’t rely on subscription state. |
XblRealTimeActivitySubscriptionGetId | On success, writes a client-side ID that isn’t related to the ID that the RTA service assigns to id and returns S_OK. | Don’t rely on subscription IDs. |