Dummy provider for unsupported platforms. More...

Inheritance diagram for CloudOnce.Internal.Providers.DummyProvider:

Collaboration diagram for CloudOnce.Internal.Providers.DummyProvider:

Public Member Functions
override void	Initialize (bool activateCloudSave=true, bool autoSignIn=true, bool autoCloudLoad=true)
	Dummy Initialize method. More...

override void	SignIn (bool autoCloudLoad=true, UnityAction< bool > callback=null)
	Dummy SignIn method. More...

override void	SignOut ()
	Dummy SignOut method. 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...

Properties
override string	PlayerID `[get]`
	ID for currently signed in player. Will always return DummyPlayerID when using DummyProvider.

override string	PlayerDisplayName `[get]`
	Display name for currently signed in player. Will always return DummyPlayerName when using DummyProvider.

override Texture2D	PlayerImage `[get]`
	Profile picture for currently signed in player. Will always return Texture2D.whiteTexture when using DummyProvider.

override bool	IsSignedIn `[get]`
	Whether or not the user is currently signed in. Is always disabled when using DummyProvider.

bool	CloudSaveInitialized `[get]`
	Whether or not Cloud Save has been initialized. Is always `false` when using DummyProvider.

override bool	CloudSaveEnabled `[get, set]`
	Whether or not Cloud Save is enabled. Is always disabled when using DummyProvider.

override ICloudStorageProvider	Storage `[get, protected set]`
	Dummy storage wrapper.

Properties inherited from CloudOnce.Internal.CloudProviderBase< DummyProvider >
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

Additional Inherited Members
Protected Member Functions inherited from CloudOnce.Internal.CloudProviderBase< DummyProvider >
virtual void	OnAwake ()

virtual void	OnOnDestroy ()

Detailed Description

Dummy provider for unsupported platforms.

Member Function Documentation

◆ Initialize()

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

inlinevirtual

Dummy Initialize method.

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< DummyProvider >.

◆ LoadUsers()

override void CloudOnce.Internal.Providers.DummyProvider.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< DummyProvider >.

◆ SignIn()

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

inlinevirtual

Dummy SignIn method.

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< DummyProvider >.

◆ SignOut()

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

inlinevirtual

Dummy SignOut method.

Implements CloudOnce.Internal.CloudProviderBase< DummyProvider >.

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

Assets/Extensions/CloudOnce/Providers/DummyProvider/DummyProvider.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Initialize()

◆ LoadUsers()

◆ SignIn()

◆ SignOut()