AccelByte.Api.BinaryCloudSave Class Reference

Inheritance diagram for AccelByte.Api.BinaryCloudSave:

Public Member Functions
void	SaveUserBinaryRecord (string key, string fileType, ResultCallback< SaveBinaryRecordResponse > callback, bool isPublic=false)
	Save a namespace-level user binary. If the binary doesn't exist, it will create the binary save, if already exists, it will append to the existing one.
void	GetCurrentUserBinaryRecord (string key, ResultCallback< UserBinaryRecord > callback)
	Get current user's binary record.
void	GetPublicUserBinaryRecord (string key, string userId, ResultCallback< UserBinaryRecord > callback)
	Get a user's public binary record by its key and the owner's UserId.
void	BulkGetCurrentUserBinaryRecords (string[] keys, ResultCallback< ListUserBinaryRecords > callback)
	Bulk get current user's binary records by their keys.
void	BulkGetPublicUserBinaryRecords (string[] keys, string userId, ResultCallback< ListUserBinaryRecords > callback)
	Bulk get multiple public binary records from a single user by their keys.
void	BulkGetPublicUserBinaryRecords (string key, string[] userIds, ResultCallback< ListUserBinaryRecords > callback)
	Bulk get public binary records with the same key from multiple users.
void	BulkQueryCurrentUserBinaryRecords (string query, ResultCallback< PaginatedUserBinaryRecords > callback, int offset=0, int limit=20)
	Bulk query current user's binary records.
void	BulkQueryPublicUserBinaryRecords (string userId, ResultCallback< PaginatedUserBinaryRecords > callback, int offset=0, int limit=20)
	Bulk query all of a user's public binary records.
void	UpdateUserBinaryRecordFile (string key, string contentType, string fileLocation, ResultCallback< UserBinaryRecord > callback)
	Update current user's binary record to point to an uploaded file.
void	UpdateUserBinaryRecordMetadata (string key, bool isPublic, ResultCallback< UserBinaryRecord > callback)
	Update current user's binary record's metadata.
void	RequestUserBinaryRecordPresignedUrl (string key, string fileType, ResultCallback< RequestUserBinaryRecordPresignedUrlResponse > callback)
	Delete current user's binary record under the given key.
void	GetGameBinaryRecord (string key, ResultCallback< GameBinaryRecord > callback)
	Get a game binary record by its key.
void	BulkGetGameBinaryRecords (string[] keys, ResultCallback< ListGameBinaryRecords > callback)
	Bulk get game binary records by their keys.
void	BulkQueryGameBinaryRecords (string query, ResultCallback< PaginatedGameBinaryRecords > callback, int offset=0, int limit=20)
	Bulk get game binary records using a query.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Member Function Documentation

BulkGetCurrentUserBinaryRecords()

void AccelByte.Api.BinaryCloudSave.BulkGetCurrentUserBinaryRecords ( string[] keys, ResultCallback< ListUserBinaryRecords > callback )

inline

Bulk get current user's binary records by their keys.

Parameters

keys	List of the keys of the binary records.
callback	Returns a Result that contains ListUserBinaryRecords via callback when completed.

BulkGetGameBinaryRecords()

void AccelByte.Api.BinaryCloudSave.BulkGetGameBinaryRecords ( string[] keys, ResultCallback< ListGameBinaryRecords > callback )

inline

Bulk get game binary records by their keys.

Parameters

keys	List of keys of the binary records
callback	Returns a Result that contains ListGameBinaryRecords via callback when completed

BulkGetPublicUserBinaryRecords() [1/2]

void AccelByte.Api.BinaryCloudSave.BulkGetPublicUserBinaryRecords ( string key, string[] userIds, ResultCallback< ListUserBinaryRecords > callback )

inline

Bulk get public binary records with the same key from multiple users.

Parameters

key	Key of the binary records
userIds	UserId list of the binary record owner(s)
callback	Returns a Result that contains ListUserBinaryRecords via callback when completed

BulkGetPublicUserBinaryRecords() [2/2]

void AccelByte.Api.BinaryCloudSave.BulkGetPublicUserBinaryRecords ( string[] keys, string userId, ResultCallback< ListUserBinaryRecords > callback )

inline

Bulk get multiple public binary records from a single user by their keys.

Parameters

keys	List of the keys of the binary records.
userId	ID of the user who owns the binary records.
callback	Returns a Result that contains ListUserBinaryRecords via callback when completed.

BulkQueryCurrentUserBinaryRecords()

void AccelByte.Api.BinaryCloudSave.BulkQueryCurrentUserBinaryRecords ( string query, ResultCallback< PaginatedUserBinaryRecords > callback, int offset = 0, int limit = 20 )

inline

Bulk query current user's binary records.

Parameters

query	String that will be used to query the user's keys
callback	Returns a Result that contains PaginatedUserBinaryRecords via callback when completed
offset	The offset of the binary records. Default value is 0
limit	The limit of the binary records. Default value is 0

BulkQueryGameBinaryRecords()

void AccelByte.Api.BinaryCloudSave.BulkQueryGameBinaryRecords ( string query, ResultCallback< PaginatedGameBinaryRecords > callback, int offset = 0, int limit = 20 )

inline

Bulk get game binary records using a query.

Parameters

query	String that will be used to query the game's binary record keys
callback	Returns a Result that contains PaginatedGameBinaryRecords via callback when completed
offset	The offset of the binary records. Default value is 0
limit	The limit of the binary records. Default value is 0

BulkQueryPublicUserBinaryRecords()

void AccelByte.Api.BinaryCloudSave.BulkQueryPublicUserBinaryRecords ( string userId, ResultCallback< PaginatedUserBinaryRecords > callback, int offset = 0, int limit = 20 )

inline

Bulk query all of a user's public binary records.

Parameters

userId	ID of the user who owns the binary records
callback	Returns a Result that contains PaginatedUserBinaryRecords via callback when completed
offset	The offset of the binary records. Default value is 0
limit	The limit of the binary records. Default value is 0

GetCurrentUserBinaryRecord()

void AccelByte.Api.BinaryCloudSave.GetCurrentUserBinaryRecord ( string key, ResultCallback< UserBinaryRecord > callback )

inline

Get current user's binary record.

Parameters

key	Key of the binary record.
callback	Returns a Result that contains UserBinaryRecord via callback when completed.

GetGameBinaryRecord()

void AccelByte.Api.BinaryCloudSave.GetGameBinaryRecord ( string key, ResultCallback< GameBinaryRecord > callback )

inline

Get a game binary record by its key.

Parameters

key	Key of the binary record
callback	Returns a Result that contains GameBinaryRecord via callback when completed

GetPublicUserBinaryRecord()

void AccelByte.Api.BinaryCloudSave.GetPublicUserBinaryRecord ( string key, string userId, ResultCallback< UserBinaryRecord > callback )

inline

Get a user's public binary record by its key and the owner's UserId.

Parameters

key	Key of the binary record.
userId	ID of the user who owns the binary record.
callback	Returns a Result that contains UserBinaryRecord via callback when completed.

RequestUserBinaryRecordPresignedUrl()

void AccelByte.Api.BinaryCloudSave.RequestUserBinaryRecordPresignedUrl ( string key, string fileType, ResultCallback< RequestUserBinaryRecordPresignedUrlResponse > callback )

inline

Delete current user's binary record under the given key.

Parameters

key

Key of the binary record that will be deleted</param``> Parameters callback Returns a Result via callback when completed */ public void DeleteUserBinaryRecord(string key , ResultCallback callback) { Report.GetFunctionLog(GetType().Name); if (!session.IsValid()) { callback?.TryError(ErrorCode.IsNotLoggedIn); return; } binaryCloudSaveApi.DeleteUserBinaryRecord(key, callback); }

/**

Request a presigned url to upload current user's binary record file

Parameters

key	Key of the binary record
fileType	File type of the binary (supported file types are jpeg, jpg, png, bmp, gif, mp3, webp, and bin)
callback	Returns a Result that contains BinaryInfo via callback when completed

SaveUserBinaryRecord()

void AccelByte.Api.BinaryCloudSave.SaveUserBinaryRecord ( string key, string fileType, ResultCallback< SaveBinaryRecordResponse > callback, bool isPublic = false )

inline

Save a namespace-level user binary. If the binary doesn't exist, it will create the binary save, if already exists, it will append to the existing one.

Parameters

key	Key of the binary record.
fileType	File type of the binary (supported file types are jpeg, jpg, png, bmp, gif, mp3, webp, and bin).
callback	Returns a Result that contains UserBinaryRecord via callback when completed.
isPublic	Whether to save the binary as a public or private record. (Optional)

UpdateUserBinaryRecordFile()

void AccelByte.Api.BinaryCloudSave.UpdateUserBinaryRecordFile ( string key, string contentType, string fileLocation, ResultCallback< UserBinaryRecord > callback )

inline

Update current user's binary record to point to an uploaded file.

Parameters

userId	ID of the user who owns the binary record
key	Key of the binary record that will be updated
contentType	Content type of the uploaded file, taken from the callback after requesting a presigned upload URL using RequestUserBinaryRecordPresignedUrl
fileLocation	Location of the uploaded file, taken from the callback after requesting a presigned upload URL using RequestUserBinaryRecordPresignedUrl
callback	Returns a Result that contains UserBinaryRecord via callback when completed

UpdateUserBinaryRecordMetadata()

void AccelByte.Api.BinaryCloudSave.UpdateUserBinaryRecordMetadata ( string key, bool isPublic, ResultCallback< UserBinaryRecord > callback )

inline

Update current user's binary record's metadata.

Parameters

userId	ID of the user who owns the binary record
key	Key of the binary record that will be updated
isPublic	Whether to update the binary record to become a public or private record
callback	Returns a Result that contains UserBinaryRecord via callback when completed