> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PartyManager

> The primary management class for interacting with the Party library.

The primary management class for interacting with the Party library.

## Syntax

```cpp theme={null}
class PartyManager  
```

## Public Methods

| Name                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [GetSingleton](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getsingleton)                                                       | Retrieves a reference to the PartyManager singleton instance.                                                                                                                                                                                                                                                                                           |
| [SetOption](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setoption)                                                             | Configures an option to fine-tune Party library functionality.                                                                                                                                                                                                                                                                                          |
| [GetOption](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getoption)                                                             | Retrieves an option used to fine-tune Party library functionality.                                                                                                                                                                                                                                                                                      |
| [GetErrorMessage](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage)                                                 | Get the human-readable form of an error generated by the Party library.                                                                                                                                                                                                                                                                                 |
| [SerializeNetworkDescriptor](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_serializenetworkdescriptor)                           | Serializes a network descriptor structure into an opaque string that is safe to communicate over title and platform-specific communication channels.                                                                                                                                                                                                    |
| [DeserializeNetworkDescriptor](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_deserializenetworkdescriptor)                       | Deserializes a network descriptor structure from an opaque string serialized via a prior call to [SerializeNetworkDescriptor()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_serializenetworkdescriptor).                                                                                               |
| [SetMemoryCallbacks](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setmemorycallbacks)                                           | Optionally configures the memory allocation and freeing callbacks the Party library should use.                                                                                                                                                                                                                                                         |
| [GetMemoryCallbacks](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getmemorycallbacks)                                           | Retrieves the memory allocation and freeing callbacks the Party library is using.                                                                                                                                                                                                                                                                       |
| [SetProfilingCallbacksForMethodEntryExit](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setprofilingcallbacksformethodentryexit) | Optionally configures the profiling event callbacks the Party library will make when entering or exiting instrumented methods.                                                                                                                                                                                                                          |
| [GetProfilingCallbacksForMethodEntryExit](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getprofilingcallbacksformethodentryexit) | Retrieves the profiling event callbacks the Party library is configured to use when entering or exiting instrumented methods.                                                                                                                                                                                                                           |
| [SetThreadAffinityMask](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setthreadaffinitymask)                                     | Optionally configures the processor on which internal Party library threads run.                                                                                                                                                                                                                                                                        |
| [GetThreadAffinityMask](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getthreadaffinitymask)                                     | Retrieves the current set of processors on which internal Party library threads will run or are running as an affinity mask.                                                                                                                                                                                                                            |
| [SetWorkMode](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_setworkmode)                                                         | Configures the work mode of the Party library processing task associated with `threadId`.                                                                                                                                                                                                                                                               |
| [GetWorkMode](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getworkmode)                                                         | Retrieves the current work mode of the Party library's internal processing task associated with `threadId`.                                                                                                                                                                                                                                             |
| [Initialize](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_initialize)                                                           | Initializes the PartyManager object instance.                                                                                                                                                                                                                                                                                                           |
| [Cleanup](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_cleanup)                                                                 | Immediately reclaims all resources associated with all Party library objects.                                                                                                                                                                                                                                                                           |
| [StartProcessingStateChanges](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges)                         | Retrieves an array of all PartyStateChanges to process since the last such call.                                                                                                                                                                                                                                                                        |
| [FinishProcessingStateChanges](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_finishprocessingstatechanges)                       | Returns an array of PartyStateChanges that were being processed.                                                                                                                                                                                                                                                                                        |
| [DoWork](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_dowork)                                                                   | Synchronously performs the processing task associated with `threadId`.                                                                                                                                                                                                                                                                                  |
| [GetRegions](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getregions)                                                           | Gets an array containing the set of regions for which your title is configured, along with round trip latency information.                                                                                                                                                                                                                              |
| [CreateNewNetwork](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createnewnetwork)                                               | Queues an asynchronous attempt to create a new network.                                                                                                                                                                                                                                                                                                 |
| [ConnectToNetwork](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_connecttonetwork)                                               | Queues an asynchronous attempt to connect to a network.                                                                                                                                                                                                                                                                                                 |
| [GetLocalDevice](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getlocaldevice)                                                   | Gets the local device.                                                                                                                                                                                                                                                                                                                                  |
| [CreateLocalUser](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser)                                                 | Creates a local user object that is used to represent a local player when performing networking and chat operations.                                                                                                                                                                                                                                    |
| [CreateLocalUserWithEntityType](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype)                     | Creates a local user object that is used to represent a supported PlayFab Entity ID and type when performing networking and chat operations.                                                                                                                                                                                                            |
| [DestroyLocalUser](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_destroylocaluser)                                               | Starts an asynchronous operation to destroy a local user.                                                                                                                                                                                                                                                                                               |
| [GetLocalUsers](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getlocalusers)                                                     | Gets an array containing all local users created by [CreateLocalUser()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser) or [CreateLocalUserWithEntityType()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype). |
| [GetNetworks](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getnetworks)                                                         | Gets an array of all networks to which the local device is connected or connecting.                                                                                                                                                                                                                                                                     |
| [GetChatControls](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_getchatcontrols)                                                 | Gets an array that contains a combined list of all chat controls on the local device and all remote devices.                                                                                                                                                                                                                                            |

## Remarks

Only a single instance of the class is permitted.

## Requirements

**Header:** Party.h

## See also

[Party members](/services/playfab/multiplayer/networking/reference/party_members)
