Namespace Unity.PlatformToolkit

Classes

CorruptedSaveException

Thrown when a corrupted save has been found.

DataStore

DataStore stores string, float, and integer values that can be easily saved and loaded using the ISavingSystem.

InvalidAccountException

Thrown when attempting to use a signed out account.

Thrown when a system in use is no longer valid and needs to be reinitialized. For rare edge cases where we can’t safely and silently reinitialize a system. If a system is invalid because its account is invalid, throw InvalidAccountException instead.

NotEnoughSpaceException

Thrown when attempting to write more data than is available to a user or is available on the system.

PlatformToolkit

A static entry-point interface for using PlatformToolkit.

This interface is used to initialize the toolkit as well as get handles to major subsystems.

SaveSystemLimitException

Thrown when hitting some limit of a saving system other than not enough storage space.

TemporarilyUnavailableException

Thrown when an operation failed due to some temporary state, like no network connection.

UserRefusalException

Thrown when an operation fails due to user choice. For example, a user cancels the sign-in UI without signing in.

Interfaces

IAccount

Abstraction of platform-specific account.

IAccountPickerSystem

Provides access to a system prompt for signing in or selecting an account.

IAccountSystem

Provides access to all IAccount related functionality.

IAchievementSystem

Provides access to achievement functionality.

ICapabilities

Capabilities system specifies what capabilities are available in the current implementation.

IInputDevice

Interface for referring to platform devices used as part of input ownership.

IInputOwnershipSystem

Allows finding which account owns an input device and track when ownership changes.

IPlatformToolkit

Platform Toolkit implementation. Accessed through PlatformToolkit class.

IPrimaryAccountSystem

Provides access to all primary account related functionality.

ISaveReadable

Save opened for reading.

ISaveWritable

Save opened for writing.

ISavingSystem

Provides access to saving functionality.

Enums

AccountState

Indicates if an IAccount object is signed in or signed out.