PlayFab.PlayFabClientInstanceAPI Class Reference

APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking, reporting, and platform-specific functionality. More...

Inheritance diagram for PlayFab.PlayFabClientInstanceAPI:

Public Member Functions
	PlayFabClientInstanceAPI (PlayFabApiSettings settings)
	PlayFabClientInstanceAPI (PlayFabAuthenticationContext context)
	PlayFabClientInstanceAPI (PlayFabApiSettings settings, PlayFabAuthenticationContext context)
bool	IsClientLoggedIn ()
	Verify client login.
void	ForgetAllCredentials ()
	Clear the Client SessionToken which allows this Client to call API calls requiring login. A new/fresh login will be required after calling this.
void	AcceptTrade (AcceptTradeRequest request, Action< AcceptTradeResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories.
void	AddFriend (AddFriendRequest request, Action< AddFriendResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
void	AddGenericID (AddGenericIDRequest request, Action< AddGenericIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.
void	AddOrUpdateContactEmail (AddOrUpdateContactEmailRequest request, Action< AddOrUpdateContactEmailResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds or updates a contact email to the player's profile.
void	AddSharedGroupMembers (AddSharedGroupMembersRequest request, Action< AddSharedGroupMembersResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data.
void	AddUsernamePassword (AddUsernamePasswordRequest request, Action< AddUsernamePasswordResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.
void	AddUserVirtualCurrency (AddUserVirtualCurrencyRequest request, Action< ModifyUserVirtualCurrencyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Increments the user's balance of the specified virtual currency by the stated amount.
void	AndroidDevicePushNotificationRegistration (AndroidDevicePushNotificationRegistrationRequest request, Action< AndroidDevicePushNotificationRegistrationResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Registers the Android device to receive push notifications.
void	AttributeInstall (AttributeInstallRequest request, Action< AttributeInstallResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Attributes an install for advertisment.
void	CancelTrade (CancelTradeRequest request, Action< CancelTradeResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player).
void	ConfirmPurchase (ConfirmPurchaseRequest request, Action< ConfirmPurchaseResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate.
void	ConsumeItem (ConsumeItemRequest request, Action< ConsumeItemResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.
void	ConsumeMicrosoftStoreEntitlements (ConsumeMicrosoftStoreEntitlementsRequest request, Action< ConsumeMicrosoftStoreEntitlementsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Grants the player's current entitlements from Microsoft Store's Collection API.
void	ConsumePS5Entitlements (ConsumePS5EntitlementsRequest request, Action< ConsumePS5EntitlementsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Checks for any new PS5 entitlements. If any are found, they are consumed (if they're consumables) and added as PlayFab items.
void	ConsumePSNEntitlements (ConsumePSNEntitlementsRequest request, Action< ConsumePSNEntitlementsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items.
void	ConsumeXboxEntitlements (ConsumeXboxEntitlementsRequest request, Action< ConsumeXboxEntitlementsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
void	CreateSharedGroup (CreateSharedGroupRequest request, Action< CreateSharedGroupResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data.
void	ExecuteCloudScript (ExecuteCloudScriptRequest request, Action< ExecuteCloudScriptResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player.
void	ExecuteCloudScript< TOut > (ExecuteCloudScriptRequest request, Action< ExecuteCloudScriptResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
void	GetAccountInfo (GetAccountInfoRequest request, Action< GetAccountInfoResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the user's PlayFab account details.
void	GetAdPlacements (GetAdPlacementsRequest request, Action< GetAdPlacementsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Returns a list of ad placements and a reward for each.
void	GetAllUsersCharacters (ListUsersCharactersRequest request, Action< ListUsersCharactersResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
void	GetCatalogItems (GetCatalogItemsRequest request, Action< GetCatalogItemsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.
void	GetCharacterData (GetCharacterDataRequest request, Action< GetCharacterDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the title-specific custom data for the character which is readable and writable by the client.
void	GetCharacterInventory (GetCharacterInventoryRequest request, Action< GetCharacterInventoryResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the specified character's current inventory of virtual goods.
void	GetCharacterLeaderboard (GetCharacterLeaderboardRequest request, Action< GetCharacterLeaderboardResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard.
void	GetCharacterReadOnlyData (GetCharacterDataRequest request, Action< GetCharacterDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the title-specific custom data for the character which can only be read by the client.
void	GetCharacterStatistics (GetCharacterStatisticsRequest request, Action< GetCharacterStatisticsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the details of all title-specific statistics for the user.
void	GetContentDownloadUrl (GetContentDownloadUrlRequest request, Action< GetContentDownloadUrlResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
void	GetCurrentGames (CurrentGamesRequest request, Action< CurrentGamesResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Get details about all current running game servers matching the given parameters.
void	GetFriendLeaderboard (GetFriendLeaderboardRequest request, Action< GetLeaderboardResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard.
void	GetFriendLeaderboardAroundPlayer (GetFriendLeaderboardAroundPlayerRequest request, Action< GetFriendLeaderboardAroundPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.
void	GetFriendsList (GetFriendsListRequest request, Action< GetFriendsListResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
void	GetGameServerRegions (GameServerRegionsRequest request, Action< GameServerRegionsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Get details about the regions hosting game servers matching the given parameters.
void	GetLeaderboard (GetLeaderboardRequest request, Action< GetLeaderboardResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard.
void	GetLeaderboardAroundCharacter (GetLeaderboardAroundCharacterRequest request, Action< GetLeaderboardAroundCharacterResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID.
void	GetLeaderboardAroundPlayer (GetLeaderboardAroundPlayerRequest request, Action< GetLeaderboardAroundPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.
void	GetLeaderboardForUserCharacters (GetLeaderboardForUsersCharactersRequest request, Action< GetLeaderboardForUsersCharactersResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a list of all of the user's characters for the given statistic.
void	GetPaymentToken (GetPaymentTokenRequest request, Action< GetPaymentTokenResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
void	GetPhotonAuthenticationToken (GetPhotonAuthenticationTokenRequest request, Action< GetPhotonAuthenticationTokenResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
void	GetPlayerCombinedInfo (GetPlayerCombinedInfoRequest request, Action< GetPlayerCombinedInfoResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves all of the user's different kinds of info.
void	GetPlayerProfile (GetPlayerProfileRequest request, Action< GetPlayerProfileResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the player's profile.
void	GetPlayerSegments (GetPlayerSegmentsRequest request, Action< GetPlayerSegmentsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	List all segments that a player currently belongs to at this moment in time.
void	GetPlayerStatistics (GetPlayerStatisticsRequest request, Action< GetPlayerStatisticsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.
void	GetPlayerStatisticVersions (GetPlayerStatisticVersionsRequest request, Action< GetPlayerStatisticVersionsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the information on the available versions of the specified statistic.
void	GetPlayerTags (GetPlayerTagsRequest request, Action< GetPlayerTagsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Get all tags with a given Namespace (optional) from a player profile.
void	GetPlayerTrades (GetPlayerTradesRequest request, Action< GetPlayerTradesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Gets all trades the player has either opened or accepted, optionally filtered by trade status.
void	GetPlayFabIDsFromFacebookIDs (GetPlayFabIDsFromFacebookIDsRequest request, Action< GetPlayFabIDsFromFacebookIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
void	GetPlayFabIDsFromFacebookInstantGamesIds (GetPlayFabIDsFromFacebookInstantGamesIdsRequest request, Action< GetPlayFabIDsFromFacebookInstantGamesIdsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
void	GetPlayFabIDsFromGameCenterIDs (GetPlayFabIDsFromGameCenterIDsRequest request, Action< GetPlayFabIDsFromGameCenterIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).
void	GetPlayFabIDsFromGenericIDs (GetPlayFabIDsFromGenericIDsRequest request, Action< GetPlayFabIDsFromGenericIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.
void	GetPlayFabIDsFromGoogleIDs (GetPlayFabIDsFromGoogleIDsRequest request, Action< GetPlayFabIDsFromGoogleIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls.
void	GetPlayFabIDsFromKongregateIDs (GetPlayFabIDsFromKongregateIDsRequest request, Action< GetPlayFabIDsFromKongregateIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).
void	GetPlayFabIDsFromNintendoSwitchDeviceIds (GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest request, Action< GetPlayFabIDsFromNintendoSwitchDeviceIdsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch identifiers.
void	GetPlayFabIDsFromPSNAccountIDs (GetPlayFabIDsFromPSNAccountIDsRequest request, Action< GetPlayFabIDsFromPSNAccountIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of PlayStation Network identifiers.
void	GetPlayFabIDsFromSteamIDs (GetPlayFabIDsFromSteamIDsRequest request, Action< GetPlayFabIDsFromSteamIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
void	GetPlayFabIDsFromTwitchIDs (GetPlayFabIDsFromTwitchIDsRequest request, Action< GetPlayFabIDsFromTwitchIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
void	GetPlayFabIDsFromXboxLiveIDs (GetPlayFabIDsFromXboxLiveIDsRequest request, Action< GetPlayFabIDsFromXboxLiveIDsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
void	GetPublisherData (GetPublisherDataRequest request, Action< GetPublisherDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the key-value store of custom publisher settings.
void	GetPurchase (GetPurchaseRequest request, Action< GetPurchaseResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.
void	GetSharedGroupData (GetSharedGroupDataRequest request, Action< GetSharedGroupDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data.
void	GetStoreItems (GetStoreItemsRequest request, Action< GetStoreItemsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the set of items defined for the specified store, including all prices defined.
void	GetTime (GetTimeRequest request, Action< GetTimeResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the current server time.
void	GetTitleData (GetTitleDataRequest request, Action< GetTitleDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the key-value store of custom title settings.
void	GetTitleNews (GetTitleNewsRequest request, Action< GetTitleNewsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the title news feed, as configured in the developer portal.
void	GetTitlePublicKey (GetTitlePublicKeyRequest request, Action< GetTitlePublicKeyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Returns the title's base 64 encoded RSA CSP blob.
void	GetTradeStatus (GetTradeStatusRequest request, Action< GetTradeStatusResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Gets the current status of an existing trade.
void	GetUserData (GetUserDataRequest request, Action< GetUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the title-specific custom data for the user which is readable and writable by the client.
void	GetUserInventory (GetUserInventoryRequest request, Action< GetUserInventoryResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the user's current inventory of virtual goods.
void	GetUserPublisherData (GetUserDataRequest request, Action< GetUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the publisher-specific custom data for the user which is readable and writable by the client.
void	GetUserPublisherReadOnlyData (GetUserDataRequest request, Action< GetUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the publisher-specific custom data for the user which can only be read by the client.
void	GetUserReadOnlyData (GetUserDataRequest request, Action< GetUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Retrieves the title-specific custom data for the user which can only be read by the client.
void	GrantCharacterToUser (GrantCharacterToUserRequest request, Action< GrantCharacterToUserResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
void	LinkAndroidDeviceID (LinkAndroidDeviceIDRequest request, Action< LinkAndroidDeviceIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Android device identifier to the user's PlayFab account.
void	LinkApple (LinkAppleRequest request, Action< EmptyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Apple account associated with the token to the user's PlayFab account.
void	LinkCustomID (LinkCustomIDRequest request, Action< LinkCustomIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the custom identifier, generated by the title, to the user's PlayFab account.
void	LinkFacebookAccount (LinkFacebookAccountRequest request, Action< LinkFacebookAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account.
void	LinkFacebookInstantGamesId (LinkFacebookInstantGamesIdRequest request, Action< LinkFacebookInstantGamesIdResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Facebook Instant Games Id to the user's PlayFab account.
void	LinkGameCenterAccount (LinkGameCenterAccountRequest request, Action< LinkGameCenterAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
void	LinkGoogleAccount (LinkGoogleAccountRequest request, Action< LinkGoogleAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the currently signed-in user account to their Google account, using their Google account credentials.
void	LinkIOSDeviceID (LinkIOSDeviceIDRequest request, Action< LinkIOSDeviceIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the vendor-specific iOS device identifier to the user's PlayFab account.
void	LinkKongregate (LinkKongregateAccountRequest request, Action< LinkKongregateAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Kongregate identifier to the user's PlayFab account.
void	LinkNintendoServiceAccount (LinkNintendoServiceAccountRequest request, Action< EmptyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Nintendo account associated with the token to the user's PlayFab account.
void	LinkNintendoSwitchDeviceId (LinkNintendoSwitchDeviceIdRequest request, Action< LinkNintendoSwitchDeviceIdResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the NintendoSwitchDeviceId to the user's PlayFab account.
void	LinkOpenIdConnect (LinkOpenIdConnectRequest request, Action< EmptyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.
void	LinkPSNAccount (LinkPSNAccountRequest request, Action< LinkPSNAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the PlayStation Network account associated with the provided access code to the user's PlayFab account.
void	LinkSteamAccount (LinkSteamAccountRequest request, Action< LinkSteamAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account.
void	LinkTwitch (LinkTwitchAccountRequest request, Action< LinkTwitchAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Twitch account associated with the token to the user's PlayFab account.
void	LinkXboxAccount (LinkXboxAccountRequest request, Action< LinkXboxAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Links the Xbox Live account associated with the provided access code to the user's PlayFab account.
void	LoginWithAndroidDeviceID (LoginWithAndroidDeviceIDRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithApple (LoginWithAppleRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs in the user with a Sign in with Apple identity token.
void	LoginWithCustomID (LoginWithCustomIDRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithEmailAddress (LoginWithEmailAddressRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.
void	LoginWithFacebook (LoginWithFacebookRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithFacebookInstantGamesId (LoginWithFacebookInstantGamesIdRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
void	LoginWithGameCenter (LoginWithGameCenterRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
void	LoginWithGoogleAccount (LoginWithGoogleAccountRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using their Google account credentials.
void	LoginWithIOSDeviceID (LoginWithIOSDeviceIDRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithKongregate (LoginWithKongregateRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Kongregate player account.
void	LoginWithNintendoServiceAccount (LoginWithNintendoServiceAccountRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs in the user with a Nintendo service account token.
void	LoginWithNintendoSwitchDeviceId (LoginWithNintendoSwitchDeviceIdRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithOpenIdConnect (LoginWithOpenIdConnectRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.
void	LoginWithPlayFab (LoginWithPlayFabRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
void	LoginWithPSN (LoginWithPSNRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a PlayStation Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithSteam (LoginWithSteamRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	LoginWithTwitch (LoginWithTwitchRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Twitch access token.
void	LoginWithXbox (LoginWithXboxRequest request, Action< LoginResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
void	Matchmake (MatchmakeRequest request, Action< MatchmakeResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be GameNotFound.
void	OpenTrade (OpenTradeRequest request, Action< OpenTradeResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
void	PayForPurchase (PayForPurchaseRequest request, Action< PayForPurchaseResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Selects a payment option for purchase order created via StartPurchase.
void	PurchaseItem (PurchaseItemRequest request, Action< PurchaseItemResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
void	RedeemCoupon (RedeemCouponRequest request, Action< RedeemCouponResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.
void	RefreshPSNAuthToken (RefreshPSNAuthTokenRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Uses the supplied OAuth code to refresh the internally cached player PSN auth token.
void	RegisterForIOSPushNotification (RegisterForIOSPushNotificationRequest request, Action< RegisterForIOSPushNotificationResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Registers the iOS device to receive push notifications.
void	RegisterPlayFabUser (RegisterPlayFabUserRequest request, Action< RegisterPlayFabUserResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address.
void	RemoveContactEmail (RemoveContactEmailRequest request, Action< RemoveContactEmailResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes a contact email from the player's profile.
void	RemoveFriend (RemoveFriendRequest request, Action< RemoveFriendResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes a specified user from the friend list of the local user.
void	RemoveGenericID (RemoveGenericIDRequest request, Action< RemoveGenericIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes the specified generic service identifier from the player's PlayFab account.
void	RemoveSharedGroupMembers (RemoveSharedGroupMembersRequest request, Action< RemoveSharedGroupMembersResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data.
void	ReportAdActivity (ReportAdActivityRequest request, Action< ReportAdActivityResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Report player's ad activity.
void	ReportDeviceInfo (DeviceInfoRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Write a PlayStream event to describe the provided player device information. This API method is not designed to be called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
void	ReportPlayer (ReportPlayerClientRequest request, Action< ReportPlayerClientResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.
void	RestoreIOSPurchases (RestoreIOSPurchasesRequest request, Action< RestoreIOSPurchasesResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Restores all in-app purchases based on the given restore receipt.
void	RewardAdActivity (RewardAdActivityRequest request, Action< RewardAdActivityResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Reward player's ad activity.
void	SendAccountRecoveryEmail (SendAccountRecoveryEmailRequest request, Action< SendAccountRecoveryEmailResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.
void	SetFriendTags (SetFriendTagsRequest request, Action< SetFriendTagsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates the tag list for a specified user in the friend list of the local user.
void	SetPlayerSecret (SetPlayerSecretRequest request, Action< SetPlayerSecretResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.
void	StartGame (StartGameRequest request, Action< StartGameResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Start a new game server with a given configuration, add the current player and return the connection information.
void	StartPurchase (StartPurchaseRequest request, Action< StartPurchaseResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates an order for a list of items from the title catalog.
void	SubtractUserVirtualCurrency (SubtractUserVirtualCurrencyRequest request, Action< ModifyUserVirtualCurrencyResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
void	UnlinkAndroidDeviceID (UnlinkAndroidDeviceIDRequest request, Action< UnlinkAndroidDeviceIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Android device identifier from the user's PlayFab account.
void	UnlinkApple (UnlinkAppleRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Apple account from the user's PlayFab account.
void	UnlinkCustomID (UnlinkCustomIDRequest request, Action< UnlinkCustomIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related custom identifier from the user's PlayFab account.
void	UnlinkFacebookAccount (UnlinkFacebookAccountRequest request, Action< UnlinkFacebookAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Facebook account from the user's PlayFab account.
void	UnlinkFacebookInstantGamesId (UnlinkFacebookInstantGamesIdRequest request, Action< UnlinkFacebookInstantGamesIdResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Facebook Instant Game Ids from the user's PlayFab account.
void	UnlinkGameCenterAccount (UnlinkGameCenterAccountRequest request, Action< UnlinkGameCenterAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Game Center account from the user's PlayFab account.
void	UnlinkGoogleAccount (UnlinkGoogleAccountRequest request, Action< UnlinkGoogleAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
void	UnlinkIOSDeviceID (UnlinkIOSDeviceIDRequest request, Action< UnlinkIOSDeviceIDResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related iOS device identifier from the user's PlayFab account.
void	UnlinkKongregate (UnlinkKongregateAccountRequest request, Action< UnlinkKongregateAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Kongregate identifier from the user's PlayFab account.
void	UnlinkNintendoServiceAccount (UnlinkNintendoServiceAccountRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Nintendo account from the user's PlayFab account.
void	UnlinkNintendoSwitchDeviceId (UnlinkNintendoSwitchDeviceIdRequest request, Action< UnlinkNintendoSwitchDeviceIdResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account.
void	UnlinkOpenIdConnect (UnlinkOpenIdConnectRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID Connect provider.
void	UnlinkPSNAccount (UnlinkPSNAccountRequest request, Action< UnlinkPSNAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related PSN account from the user's PlayFab account.
void	UnlinkSteamAccount (UnlinkSteamAccountRequest request, Action< UnlinkSteamAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Steam account from the user's PlayFab account.
void	UnlinkTwitch (UnlinkTwitchAccountRequest request, Action< UnlinkTwitchAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Twitch account from the user's PlayFab account.
void	UnlinkXboxAccount (UnlinkXboxAccountRequest request, Action< UnlinkXboxAccountResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Unlinks the related Xbox Live account from the user's PlayFab account.
void	UnlockContainerInstance (UnlockContainerInstanceRequest request, Action< UnlockContainerItemResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
void	UnlockContainerItem (UnlockContainerItemRequest request, Action< UnlockContainerItemResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
void	UpdateAvatarUrl (UpdateAvatarUrlRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Update the avatar URL of the player.
void	UpdateCharacterData (UpdateCharacterDataRequest request, Action< UpdateCharacterDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates and updates the title-specific custom data for the user's character which is readable and writable by the client.
void	UpdateCharacterStatistics (UpdateCharacterStatisticsRequest request, Action< UpdateCharacterStatisticsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
void	UpdatePlayerStatistics (UpdatePlayerStatisticsRequest request, Action< UpdatePlayerStatisticsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
void	UpdateSharedGroupData (UpdateSharedGroupDataRequest request, Action< UpdateSharedGroupDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data.
void	UpdateUserData (UpdateUserDataRequest request, Action< UpdateUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates and updates the title-specific custom data for the user which is readable and writable by the client.
void	UpdateUserPublisherData (UpdateUserDataRequest request, Action< UpdateUserDataResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Creates and updates the publisher-specific custom data for the user which is readable and writable by the client.
void	UpdateUserTitleDisplayName (UpdateUserTitleDisplayNameRequest request, Action< UpdateUserTitleDisplayNameResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Updates the title specific display name for the user.
void	ValidateAmazonIAPReceipt (ValidateAmazonReceiptRequest request, Action< ValidateAmazonReceiptResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item.
void	ValidateGooglePlayPurchase (ValidateGooglePlayPurchaseRequest request, Action< ValidateGooglePlayPurchaseResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Validates a Google Play purchase and gives the corresponding item to the player.
void	ValidateIOSReceipt (ValidateIOSReceiptRequest request, Action< ValidateIOSReceiptResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item.
void	ValidateWindowsStoreReceipt (ValidateWindowsReceiptRequest request, Action< ValidateWindowsReceiptResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item.
void	WriteCharacterEvent (WriteClientCharacterEventRequest request, Action< WriteEventResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Writes a character-based event into PlayStream.
void	WritePlayerEvent (WriteClientPlayerEventRequest request, Action< WriteEventResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Writes a player-based event into PlayStream.
void	WriteTitleEvent (WriteTitleEventRequest request, Action< WriteEventResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
	Writes a title-based event into PlayStream.

Public Attributes
readonly PlayFabApiSettings	apiSettings = null
readonly PlayFabAuthenticationContext	authenticationContext = null

Detailed Description

APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking, reporting, and platform-specific functionality.

---

The documentation for this class was generated from the following file:

• C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/PlayFabSDK/Client/PlayFabClientInstanceAPI.cs