CloudOnce.Internal.Providers.TestProvider Class Reference

Provides a minimal implementation of ICloudProvider, for development and testing. More...

Inheritance diagram for CloudOnce.Internal.Providers.TestProvider:

Collaboration diagram for CloudOnce.Internal.Providers.TestProvider:

Public Member Functions
override void	Initialize (bool activateCloudSave=true, bool autoSignIn=true, bool autoCloudLoad=true)
	Emulates initialization with a randomized delay. More...
override void	SignIn (bool autoCloudLoad=true, UnityAction< bool > callback=null)
	Simulates signing in. More...
override void	SignOut ()
	Simulates signing out. More...
override void	LoadUsers (string[] userIDs, Action< IUserProfile[]> callback)
	Load the user profiles associated with the given array of user IDs. More...
void	InternalInit (CloudOnceEvents events)
	Method used by Cloud to initialize the Cloud provider.
abstract void	Initialize (bool activateCloudSave=true, bool autoSignIn=true, bool autoCloudLoad=true)
	Initializes the current cloud provider. More...
abstract void	SignIn (bool autoCloudLoad=true, UnityAction< bool > callback=null)
	Signs in to the current cloud provider. More...
abstract void	SignOut ()
	Signs out of the current cloud provider. More...
abstract void	LoadUsers (string[] userIDs, Action< IUserProfile[]> callback)
	Load the user profiles associated with the given array of user IDs. More...

Protected Member Functions
override void	OnAwake ()
Protected Member Functions inherited from CloudOnce.Internal.CloudProviderBase< TestProvider >
virtual void	OnAwake ()
virtual void	OnOnDestroy ()

Properties
override string	PlayerID [get]
	ID for currently signed in player. Will return an empty string if no player is signed in.
override string	PlayerDisplayName [get]
	Display name for currently signed in player. Will return an empty string if no player is signed in.
override Texture2D	PlayerImage [get]
	Profile picture for currently signed in player. Will return null if the user has no avatar, or it has not loaded yet.
override bool	IsSignedIn [get]
	Whether or not the user is currently signed in.
bool	CloudSaveInitialized [get]
	Whether or not Cloud Save has been initialized. Is initialized with Cloud.Initialize method.
override bool	CloudSaveEnabled [get, set]
	Whether or not Cloud Save is enabled. Disabling Cloud Save will make Cloud.Storage.Save only save to disk. Can only be enabled if Cloud Save was initialized in Cloud.Initialize method.
override ICloudStorageProvider	Storage [get, protected set]
	Interface for accessing fake cloud save.
Properties inherited from CloudOnce.Internal.CloudProviderBase< TestProvider >
static T	Instance [get]
	Makes sure only one instance of the type exists.
string	ServiceName [get, protected set]
	Name of the currently used service, e.g. "Apple Game Center".
abstract string	PlayerID [get]
	ID for currently signed in player. Will return an empty string if no player is signed in.
abstract string	PlayerDisplayName [get]
	Display name for currently signed in player. Will return an empty string if no player is signed in.
abstract Texture2D	PlayerImage [get]
	Profile picture for currently signed in player. Will return null if the user has no avatar, or it has not loaded yet.
abstract bool	IsSignedIn [get]
	Whether or not the user is currently signed in.
abstract bool	CloudSaveEnabled [get, set]
	Whether or not Cloud Save is enabled. Disabling Cloud Save will make Cloud.Storage.Save only save to disk. Can only be enabled if Cloud Save was initialized in Cloud.Initialize method.
abstract ICloudStorageProvider	Storage [get, protected set]
	Interface for accessing Cloud Save on the current platform

Detailed Description

Provides a minimal implementation of ICloudProvider, for development and testing.

Member Function Documentation

Initialize()

override void CloudOnce.Internal.Providers.TestProvider.Initialize ( bool  activateCloudSave = true, bool  autoSignIn = true, bool  autoCloudLoad = true  )

inlinevirtual

Emulates initialization with a randomized delay.

Parameters

activateCloudSave	Whether or not Cloud Saving should be activated.
autoSignIn	Whether or not SignIn will be called automatically once the cloud provider is initialized.
autoCloudLoad	Whether or not cloud data should be loaded automatically if the user is successfully signed in. Ignored if Cloud Saving is deactivated or the user fails to sign in.

Implements CloudOnce.Internal.CloudProviderBase< TestProvider >.

LoadUsers()

override void CloudOnce.Internal.Providers.TestProvider.LoadUsers ( string[]  userIDs, Action< IUserProfile[]>  callback  )

inlinevirtual

Load the user profiles associated with the given array of user IDs.

Parameters

userIDs	The users to retrieve profiles for.
callback	Callback to handle the user profiles.

Implements CloudOnce.Internal.CloudProviderBase< TestProvider >.

OnAwake()

override void CloudOnce.Internal.Providers.TestProvider.OnAwake ( )

inlineprotectedvirtual

Reimplemented from CloudOnce.Internal.CloudProviderBase< TestProvider >.

SignIn()

override void CloudOnce.Internal.Providers.TestProvider.SignIn ( bool  autoCloudLoad = true, UnityAction< bool >  callback = null  )

inlinevirtual

Simulates signing in.

Parameters

autoCloudLoad	Whether or not cloud data should be loaded automatically when the user is successfully signed in. Ignored if Cloud Saving is deactivated or the user fails to sign in.
callback	The callback to call when authentication finishes. It will be called with true if authentication was successful, false otherwise.

Implements CloudOnce.Internal.CloudProviderBase< TestProvider >.

SignOut()

override void CloudOnce.Internal.Providers.TestProvider.SignOut ( )

inlinevirtual

Simulates signing out.

Implements CloudOnce.Internal.CloudProviderBase< TestProvider >.

---

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

• Assets/Extensions/CloudOnce/Providers/TestProvider/TestProvider.cs