Struct QueryPairedUserAccountCommand

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

Namespace: UnityEngine.InputSystem.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
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.

Properties

id

Persistent ID of the user account the platform level.

Declaration
public string id { get; set; }
Property Value
Type Description
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
String

Type

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

typeStatic

Declaration
public FourCC typeStatic { get; }
Property Value
Type Description
FourCC
Implements

Methods

Create()

Declaration
public static QueryPairedUserAccountCommand Create()
Returns
Type Description
QueryPairedUserAccountCommand