Struct QueryPairedUserAccountCommand | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct QueryPairedUserAccountCommand

    Query the ID and the name of the user paired to the device the command is sent to.

    Inherited Members
    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.Experimental.Input.LowLevel
    Syntax
    public struct QueryPairedUserAccountCommand : IInputDeviceCommandInfo
    Remarks

    This command is only supported on platforms where devices can be paired to user accounts at the platform level. Currently this is the case for Xbox and PS4. On Switch, InitiateUserAccountPairingCommand is supported but the platform does not store associations established between devices and users that way.

    Fields

    baseCommand

    Declaration
    public InputDeviceCommand baseCommand
    Field Value
    Type Description
    InputDeviceCommand

    handle

    Handle of the user account at the platform level.

    Declaration
    public ulong handle
    Field Value
    Type Description
    System.UInt64
    Remarks

    Note that this is wide enough to store a pointer and does not necessarily need to be a plain integer. How the backend determines handles for user accounts is up to the backend.

    Be aware that a handle is not guaranteed to be valid beyond the current application run. For stable, persistent user account handles,use id.

    kMaxIdLength

    Declaration
    public const int kMaxIdLength = 256
    Field Value
    Type Description
    System.Int32

    kMaxNameLength

    Declaration
    public const int kMaxNameLength = 256
    Field Value
    Type Description
    System.Int32

    kSize

    Declaration
    public const int kSize = 1040
    Field Value
    Type Description
    System.Int32

    Properties

    id

    Persistent ID of the user account the platform level.

    Declaration
    public string id { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    This ID is guaranteed to not change between application runs, device restarts, and the user changing user names on the account.

    Use this ID to associate persistent settings with.

    name

    Name of the user account at the platform level.

    Declaration
    public string name { get; set; }
    Property Value
    Type Description
    System.String

    Type

    Declaration
    public static FourCC Type { get; }
    Property Value
    Type Description
    FourCC

    Methods

    Create()

    Declaration
    public static QueryPairedUserAccountCommand Create()
    Returns
    Type Description
    QueryPairedUserAccountCommand

    GetTypeStatic()

    Declaration
    public FourCC GetTypeStatic()
    Returns
    Type Description
    FourCC
    Implements
    IInputDeviceCommandInfo.GetTypeStatic()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023