presence_c

  • Article

Enumerations

Enumeration Description
XblPresenceBroadcastProvider Defines values representing the streaming provider.
XblPresenceDetailLevel Defines values used to set the level of presence detail return from the service. Choosing proper detail level could help the performance of the API.
XblPresenceDeviceType Defines values used to indicate the device type associate with an XblSocialManagerPresenceTitleRecord.
XblPresenceMediaIdType Defines values used to indicate the media id types for media presence data.
XblPresenceTitleState Defines values used to indicate the title presence state for a user.
XblPresenceTitleViewState Defines values used to indicate the states of the screen view of presence information.
XblPresenceUserState Defines values used to indicate the state of the user with regard to the presence service.

Functions

Function Description
XblPresenceAddDevicePresenceChangedHandler Registers an event handler for device presence change notifications. Notifications will only be received for the Users configured with XblPresenceTrackUsers.
XblPresenceAddTitlePresenceChangedHandler Registers an event handler for title presence change notifications. Notifications will only be received for the Users and Titles configured with XblPresenceTrackUsers and XblPresenceTrackAdditionalTitles respectively.
XblPresenceDevicePresenceChangedHandler Event handler for device presence change notifications.
XblPresenceGetPresenceAsync Gets presence info for a specific Xbox User Id.
XblPresenceGetPresenceForMultipleUsersAsync Gets presence info for multiple users.
XblPresenceGetPresenceForMultipleUsersResult Get result for an XblPresenceGetPresenceForMultipleUsers call.
XblPresenceGetPresenceForMultipleUsersResultCount Get result count for an XblPresenceGetPresenceForMultipleUsersAsync call.
XblPresenceGetPresenceForSocialGroupAsync Gets presence info for a specific group of users.
XblPresenceGetPresenceForSocialGroupResult Get result for an XblPresenceGetPresenceForSocialGroup call.
XblPresenceGetPresenceForSocialGroupResultCount Get result count for an XblPresenceGetPresenceForSocialGroupAsync call.
XblPresenceGetPresenceResult Get result for an XblPresenceGetPresenceAsync call.
XblPresenceRecordCloseHandle Closes a XblPresenceRecordHandle.
XblPresenceRecordDuplicateHandle Duplicates a XblPresenceRecordHandle.
XblPresenceRecordGetDeviceRecords Get the device presence records associated with a returned presence record.
XblPresenceRecordGetUserState Get the global presence state for a presence record.
XblPresenceRecordGetXuid Get the Xuid for the user a presence record is associated with.
XblPresenceRemoveDevicePresenceChangedHandler Unregisters an event handler for device presence change notifications.
XblPresenceRemoveTitlePresenceChangedHandler Unregisters an event handler for title presence change notifications.
XblPresenceSetPresenceAsync Sets presence info for the current user context.
XblPresenceStopTrackingAdditionalTitles Configures the list of titles for which real-time title presence will be tracked. Title presence updates for the specified titles will no longer be received.
XblPresenceStopTrackingUsers Configures the list of users for whom real-time device and title presence updates will be tracked. Presence updates for the specified Users will no longer be received.
XblPresenceSubscribeToDevicePresenceChange Subscribes to device presence change notifications. DEPRECATED. This API continues to work, however it will be removed in a future release. Individual RTA subscription will be managed automatically by XSAPI as users are tracked with XblPresenceTrackUsers.
XblPresenceSubscribeToTitlePresenceChange Subscribes to title presence change notifications. DEPRECATED. This API will be removed in a future release. Individual RTA subscription will be managed automatically by XSAPI as titles are tracked with XblPresenceTrackAdditionalTitles.
XblPresenceTitlePresenceChangedHandler Event handler for title presence change notifications.
XblPresenceTrackAdditionalTitles Configures the list of titles for which real-time title presence will be tracked. To receive title presence updates for titles other than the current title, they must be added using this API.
XblPresenceTrackUsers Configures the list of users for whom real-time device and title presence updates will be tracked.
XblPresenceUnsubscribeFromDevicePresenceChange Unsubscribes a previously created device presence change subscription. DEPRECATED. This API continues to work, however it will be removed in a future release. Individual RTA subscription will be managed automatically by XSAPI as users are untracked with XblPresenceStopTrackingUsers.
XblPresenceUnsubscribeFromTitlePresenceChange Unsubscribes a previously created title presence change subscription. DEPRECATED. This API will be removed in a future release. Individual RTA subscription will be managed automatically by XSAPI as titles are untracked with XblPresenceStopTrackingAdditionalTitles.

Handles

Handle Description
XblPresenceRecordHandle The handle to an xbl presence record.

Structures

Structure Description
XblPresenceBroadcastRecord The broadcast information of what the user is broadcasting.
XblPresenceDeviceRecord Defines values representing the xbl presence device record.
XblPresenceQueryFilters Struct passed to presence APIs to filter the presence records returned.
XblPresenceRichPresenceIds Ids needed to set Rich Presence.
XblPresenceTitleRecord Defines values representing the xbl presence title record.