My Project
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
PlayFab.PlayFabDataInstanceAPI Class Reference

Store arbitrary data associated with an entity. Objects are small (~1KB) JSON-compatible objects which are stored directly on the entity profile. Objects are made available for use in other PlayFab contexts, such as PlayStream events and CloudScript functions. Files can efficiently store data of any size or format. Both objects and files support a flexible permissions system to control read and write access by other entities. More...

Inheritance diagram for PlayFab.PlayFabDataInstanceAPI:
PlayFab.SharedModels.IPlayFabInstanceApi

Public Member Functions

 PlayFabDataInstanceAPI (PlayFabAuthenticationContext context)
 
 PlayFabDataInstanceAPI (PlayFabApiSettings settings, PlayFabAuthenticationContext context)
 
bool IsEntityLoggedIn ()
 Verify entity 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 AbortFileUploads (AbortFileUploadsRequest request, Action< AbortFileUploadsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Abort pending file uploads to an entity's profile.
 
void DeleteFiles (DeleteFilesRequest request, Action< DeleteFilesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Delete files on an entity's profile.
 
void FinalizeFileUploads (FinalizeFileUploadsRequest request, Action< FinalizeFileUploadsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Finalize file uploads to an entity's profile.
 
void GetFiles (GetFilesRequest request, Action< GetFilesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves file metadata from an entity's profile.
 
void GetObjects (GetObjectsRequest request, Action< GetObjectsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Retrieves objects from an entity's profile.
 
void InitiateFileUploads (InitiateFileUploadsRequest request, Action< InitiateFileUploadsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Initiates file uploads to an entity's profile.
 
void SetObjects (SetObjectsRequest request, Action< SetObjectsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Sets objects on an entity's profile.
 

Public Attributes

readonly PlayFabApiSettings apiSettings = null
 
readonly PlayFabAuthenticationContext authenticationContext = null
 

Detailed Description

Store arbitrary data associated with an entity. Objects are small (~1KB) JSON-compatible objects which are stored directly on the entity profile. Objects are made available for use in other PlayFab contexts, such as PlayStream events and CloudScript functions. Files can efficiently store data of any size or format. Both objects and files support a flexible permissions system to control read and write access by other entities.


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