CloudOnce.Internal.Providers.ICloudStorageProvider Interface Reference

Interface for platform-agnostic access to cloud save. More...

Inheritance diagram for CloudOnce.Internal.Providers.ICloudStorageProvider:

Public Member Functions
void	Save ()
	Saves all cloud variables, to both disk and cloud. If Cloud.CloudSaveEnabled is false, it will only save to disk. Skips saving if no variables have been changed. More...
void	Load ()
	Loads any available cloud data (if signed in and cloud saving is enabled). More...
void	Synchronize ()
	Calls Load and then Save as soon as the Cloud load operation is complete. More...
bool	ResetVariable (string key)
	Resets a Cloud variable to the default value. More...
bool	DeleteVariable (string key)
	Deletes a specific Cloud variable from the Cloud. More...
string[]	ClearUnusedVariables ()
	Deletes all variables that exists in the cloud save, but have not been declared in the local data. Can be useful during development when variable names change, but use with caution. More...
void	DeleteAll ()
	WARNING! Deletes all cloud variables both locally and in the cloud (if logged into a cloud save service)! Should only be used during development, not in production builds. More...

Detailed Description

Interface for platform-agnostic access to cloud save.

Member Function Documentation

ClearUnusedVariables()

string[] CloudOnce.Internal.Providers.ICloudStorageProvider.ClearUnusedVariables

(

)

Deletes all variables that exists in the cloud save, but have not been declared in the local data. Can be useful during development when variable names change, but use with caution.

Returns

An array with the keys for the variables that was cleared.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

DeleteAll()

void CloudOnce.Internal.Providers.ICloudStorageProvider.DeleteAll

(

)

WARNING! Deletes all cloud variables both locally and in the cloud (if logged into a cloud save service)! Should only be used during development, not in production builds.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

DeleteVariable()

bool CloudOnce.Internal.Providers.ICloudStorageProvider.DeleteVariable

(

string

key

)

Deletes a specific Cloud variable from the Cloud.

Parameters

key	The unique identifier for the CloudPref you want to delete.

Returns

true if the CloudPref is found and deleted, false if the specified key doesn't exist.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

Load()

void CloudOnce.Internal.Providers.ICloudStorageProvider.Load

(

)

Loads any available cloud data (if signed in and cloud saving is enabled).

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

ResetVariable()

bool CloudOnce.Internal.Providers.ICloudStorageProvider.ResetVariable

(

string

key

)

Resets a Cloud variable to the default value.

Parameters

key	The unique identifier for the Cloud variable you want to reset.

Returns

Whether or not the variable was successfully reset.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

Save()

void CloudOnce.Internal.Providers.ICloudStorageProvider.Save

(

)

Saves all cloud variables, to both disk and cloud. If Cloud.CloudSaveEnabled is false, it will only save to disk. Skips saving if no variables have been changed.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

Synchronize()

void CloudOnce.Internal.Providers.ICloudStorageProvider.Synchronize

(

)

Calls Load and then Save as soon as the Cloud load operation is complete.

Implemented in CloudOnce.Internal.Providers.iOSCloudSaveWrapper, CloudOnce.Internal.Providers.DummyStorageWrapper, CloudOnce.Internal.Providers.GooglePlayGamesCloudSaveWrapper, and CloudOnce.Internal.Providers.TestProviderStorageWrapper.

---

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

• Assets/Extensions/CloudOnce/Internal/Interfaces/ICloudStorageProvider.cs