Class IUsesCloudDataStorageMethods

Extension methods for cloud data storage users

Inheritance
object
IUsesCloudDataStorageMethods
Inherited Members
Namespace: Unity.MARS.Providers
Assembly: Unity.MARS.Interfaces.dll
Syntax
[MovedFrom("Unity.MARS")]
[Obsolete("MARS Cloud storage is obsolete")]
public static class IUsesCloudDataStorageMethods

Methods

CloudLoadAsync(IUsesCloudDataStorage, string, Action<bool, long, byte[]>, ProgressCallback)

Load from the cloud asynchronously the data of an object which was saved with a known key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void CloudLoadAsync(this IUsesCloudDataStorage user, string key, Action<bool, long, byte[]> callback, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string key

string that uniquely identifies this instance of the type.
Action<bool, long, byte[]> callback

a callback which returns whether the operation was successful, as well as the response payload if it was.
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

CloudLoadAsync(IUsesCloudDataStorage, string, Action<bool, long, string>, ProgressCallback)

Load from the cloud asynchronously the data of an object which was saved with a known key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void CloudLoadAsync(this IUsesCloudDataStorage user, string key, Action<bool, long, string> callback, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string key

string that uniquely identifies this instance of the type.
Action<bool, long, string> callback

a callback which returns whether the operation was successful, as well as the serialized string of the object if it was.
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

CloudLoadTextureAsync(IUsesCloudDataStorage, string, LoadTextureCallback, ProgressCallback)

Load a texture asynchronously from cloud storage

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void CloudLoadTextureAsync(this IUsesCloudDataStorage user, string key, LoadTextureCallback callback, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string key

String that uniquely identifies this instance of the type.
LoadTextureCallback callback

A callback which returns whether the operation was successful, as well as the response payload if it was. If the operation failed, the byte array will contain the error string
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

CloudSaveAsync(IUsesCloudDataStorage, string, byte[], Action<bool, long, string>, ProgressCallback)

Save to the cloud asynchronously the data of an object of a certain type with a specified key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void CloudSaveAsync(this IUsesCloudDataStorage user, string key, byte[] bytes, Action<bool, long, string> callback = null, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string key

string that uniquely identifies this instance of the type.
byte[] bytes

bytes to save.
Action<bool, long, string> callback

a callback when the asynchronous call is done to show whether it was successful.
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

CloudSaveAsync(IUsesCloudDataStorage, string, string, Action<bool, long, string>, ProgressCallback)

Save to the cloud asynchronously the data of an object with a specified key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void CloudSaveAsync(this IUsesCloudDataStorage user, string key, string serializedObject, Action<bool, long, string> callback = null, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string key

string that uniquely identifies this instance of the type.
string serializedObject

string serialization of the object being saved.
Action<bool, long, string> callback

a callback when the asynchronous call is done to show whether it was successful.
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

GetAPIKey(IUsesCloudDataStorage)

Get the current API key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static string GetAPIKey(this IUsesCloudDataStorage user)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
Returns
Type Description
string

The current API key

GetProjectIdentifier(IUsesCloudDataStorage)

Get the current project identifier

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static string GetProjectIdentifier(this IUsesCloudDataStorage user)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
Returns
Type Description
string

The current project identifier

IsConnected(IUsesCloudDataStorage)

Get the current state of the connection to the cloud storage

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static bool IsConnected(this IUsesCloudDataStorage user)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
Returns
Type Description
bool

True if the Cloud Storage is connected to this client, false otherwise.

LoadLocalTextureAsync(IUsesCloudDataStorage, string, LoadTextureCallback, ProgressCallback)

Load a texture asynchronously from local storage

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void LoadLocalTextureAsync(this IUsesCloudDataStorage user, string path, LoadTextureCallback callback, ProgressCallback progress = null)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string path

Path to the texture.
LoadTextureCallback callback

A callback which returns whether the operation was successful, as well as the response payload if it was. If the operation failed, the byte array will contain the error string
ProgressCallback progress

Called every frame while the request is in progress with two 0-1 values indicating upload and download progress, respectively

SetAPIKey(IUsesCloudDataStorage, string)

Set the current API key

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void SetAPIKey(this IUsesCloudDataStorage user, string token)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string token

The API key to set

SetProjectIdentifier(IUsesCloudDataStorage, string)

Set the current project identifier

Declaration
[Obsolete("MARS Cloud storage is obsolete")]
public static void SetProjectIdentifier(this IUsesCloudDataStorage user, string id)
Parameters
Type Name Description
IUsesCloudDataStorage user

The functionality user
string id

The project identifier to set