Functions
| Function | Description |
|---|---|
| PFEntityCloseHandle | Closes a PFEntityHandle. |
| PFEntityDuplicateHandle | Duplicates a PFEntityHandle. |
| PFEntityGetAPIEndpoint | Gets the API endpoint for the PFServiceConfig associated with an entity handle. |
| PFEntityGetAPIEndpointSize | Gets the size of the buffer needed to hold the API endpoint string from an entity handle. |
| PFEntityGetEntityKey | Get the PFEntityKey for an entity. |
| PFEntityGetEntityKeySize | Get the size in bytes needed to store the PFEntityKey for an Entity. |
| PFEntityGetEntityTokenAsync | Get the cached PFEntityToken for an Entity. |
| PFEntityGetEntityTokenResult | Gets the result of a successful PFEntityGetEntityTokenAsync call. |
| PFEntityGetEntityTokenResultSize | Get the size in bytes needed to store the result of a PFEntityGetEntityTokenAsync call. |
| PFEntityGetSecretKey | Gets the PlayFab secretKey associated with a title Entity. Will fail with E_PF_NOSECRETKEY if there is no Secret Key associated with the provided Entity. |
| PFEntityGetSecretKeySize | Gets the size of the buffer needed to hold the PlayFab secretKey. Will fail with E_PF_NOSECRETKEY if there is no Secret Key associated with the provided Entity. |
| PFEntityIsTitlePlayer | Convenience method to check if an Entity is a Title Player. This is equivalent to calling PFEntityGetEntityKey and comparing entityKey.type to PFTitlePlayerEntityType. |
| PFEntityRegisterTokenExpiredEventHandler | Register a handler for EntityToken expired events. |
| PFEntityRegisterTokenRefreshedEventHandler | Register a handler for EntityToken refreshed events. |
| PFEntityTokenExpiredEventHandler | EntityToken expired event handler. Needed to reauthenticate players in scenarios where the SDK is unable to automatically refresh the cached EntityToken. |
| PFEntityTokenRefreshedEventHandler | A handler invoked every time an Entity is automatically re-authenticated, thus obtaining a new EntityToken. An entity will be automatically re-authenticated prior to its EntityToken expiring. |
| PFEntityUnregisterTokenExpiredEventHandler | Unregisters a previously registered callback. |
| PFEntityUnregisterTokenRefreshedEventHandler | Unregisters a previously registered PFEntityTokenRefreshedCallback. |
Structures
| Structure | Description |
|---|---|
| PFEntityToken | PlayFab EntityToken and its expiration time. Used to authenticate PlayFab service calls. |