PartyXblManager
The primary management class for interacting with the Party Xbox Live Helper library.
Syntax
class PartyXblManager
Public Methods
| Name | Description |
|---|---|
| GetSingleton | Retrieves a reference to the PartyXblManager singleton instance. |
| GetErrorMessage | Get the human-readable form of an error generated by the Party Xbox Live Helper library. |
| SetMemoryCallbacks | Optionally configures the memory allocation and freeing callbacks the Party Xbox Live Helper library should use. |
| GetMemoryCallbacks | Retrieves the current memory allocation and freeing callbacks the Party Xbox Live library is using. |
| SetProfilingCallbacksForMethodEntryExit | Optionally configures the profiling event callbacks the Party Xbox Live library will make when entering or exiting instrumented methods. |
| GetProfilingCallbacksForMethodEntryExit | Retrieves the profiling event callbacks the Party Xbox Live library is configured to use when entering or exiting instrumented methods. |
| SetThreadAffinityMask | Optionally configures the processor on which internal Party Xbox Live Helper library threads will run. |
| GetThreadAffinityMask | Retrieves the current set of processors on which internal Party Xbox Live Helper library threads will run or are running as an affinity mask. |
| Initialize | Initializes the object instance. |
| Cleanup | Immediately reclaims all resources associated with the object. |
| StartProcessingStateChanges | Retrieves an array of all Party Xbox Live state changes to process since the last such call. |
| FinishProcessingStateChanges | Returns an array of Party Xbox Live state changes that were being processed. |
| CompleteGetTokenAndSignatureRequest | Completes a GetTokenAndSignature operation. |
| CreateLocalChatUser | Queues an asynchronous attempt to create a local chat user. Privacy and privilege information related to this user will be tracked by the helper library. |
| CreateRemoteChatUser | Creates a remote chat user. A remote chat user is an Xbox Live user currently communicating with at least one local user. Creating a remote chat user will cause the library to start tracking privacy information related to this user in relation to every local chat user. |
| DestroyChatUser | Destroys a chat user. |
| GetChatUsers | Gets an array containing all chat users created by CreateLocalChatUser() and CreateRemoteChatUser(). |
| LoginToPlayFab | Signs the user in to PlayFab using an Xbox Live token, asynchronously returning an Entity Id and Entity Token that can subsequently be used for PlayFab API calls which require an authenticated PlayFab user or to create a PartyLocalUser. There is no difference between calling this method or using the LoginWithXbox method provided by the PlayFab SDK. |
| GetEntityIdsFromXboxLiveUserIds | Queues an asynchronous operation to retrieve a list of mappings between PlayFab Entity Ids and known Xbox Live User Ids. |
Remarks
Only a single instance of the class is permitted.
Requirements
Header: PartyXboxLive.h