docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IAccountSystem

    Provides access to all IAccount related functionality.

    Namespace: Unity.PlatformToolkit
    Assembly: Unity.PlatformToolkit.dll
    Syntax
    public interface IAccountSystem

    Properties

    InputOwnership

    Get the IInputOwnershipSystem.

    Declaration
    IInputOwnershipSystem InputOwnership { get; }
    Property Value
    Type Description
    IInputOwnershipSystem
    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if account-input pairing is not supported on the current platform. Use InputOwnership to check if account-input pairing is supported.

    Picker

    Get the IAccountPickerSystem.

    Declaration
    IAccountPickerSystem Picker { get; }
    Property Value
    Type Description
    IAccountPickerSystem
    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if account picker is not supported on the current platform. Use AccountPicker to check if account picker is supported.

    Primary

    Get the IPrimaryAccountSystem.

    Declaration
    IPrimaryAccountSystem Primary { get; }
    Property Value
    Type Description
    IPrimaryAccountSystem
    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if the primary account is not supported on the current platform. Use PrimaryAccount to check if the primary account is supported.

    SignedIn

    Snapshot of currently signed in accounts.

    Declaration
    IReadOnlyList<IAccount> SignedIn { get; }
    Property Value
    Type Description
    IReadOnlyList<IAccount>
    Remarks

    The returned list will not be modified after it is returned. If you keep an instance of this list, it will get outdated, if accounts sign in or sign out.

    Events

    OnChange

    Invoked after a new account signs in and after a signed in account signs out. Event provides an IAccount that changed and AccountState showing the new state of the account.

    Declaration
    event Action<IAccount, AccountState> OnChange
    Event Type
    Type Description
    Action<IAccount, AccountState>
    Remarks

    SignedIn event is invoked after the account is added to SignedIn. SignedOut event is invoked after the account is removed from SignedIn.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)