Console

AccountLoginTrait 

struct AccountLoginTrait

This trait provides commands to facilitate user account login on a content app or a node.

  • List of the event types that are supported by AccountLoginTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by AccountLoginTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the AccountLoginTrait.

    Declaration

    Swift

    let attributes: Matter.AccountLoginTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the AccountLoginTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Matter.AccountLoginTrait, rhs: Matter.AccountLoginTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Whether the device supports the getSetupPin command for this trait.

    Declaration

    Swift

    var supportsGetSetupPinCommand: Bool { get }

  • Determine if the active user account of the given content app matches the active user account of the given commissionee, and if it does, return a setup PIN which can be used to establish a password-authenticated session with the commissionee.

    Declaration

    Swift

    func getSetupPin(tempAccountIdentifier: String) async throws -> Matter.AccountLoginTrait.GetSetupPinCommandResponse

    Parameters

    tempAccountIdentifier

    The client’s temporary account identifier.

    Return Value

    Contains the setup PIN.

  • The batchable version of getSetupPin command above.

    See also

    getSetupPin

    Declaration

    Swift

    func getSetupPinBatchable(tempAccountIdentifier: String) throws -> BatchableCommand<Matter.AccountLoginTrait.GetSetupPinCommandResponse>

  • Whether the device supports the login command for this trait.

    Declaration

    Swift

    var supportsLoginCommand: Bool { get }

  • Allow the content app to assume the user account of the given commissionee by leveraging the setup PIN input by the user during the commissioning process.

    Declaration

    Swift

    func login(tempAccountIdentifier: String, setupPin: String, optionalArgsProvider: ((Matter.AccountLoginTrait.LoginCommand.OptionalArgs) -> Void)? = nil) async throws

    Parameters

    tempAccountIdentifier

    The client’s temporary account identifier.
    setupPin

    The setup PIN.

  • The batchable version of login command above.

    See also

    login

    Declaration

    Swift

    func loginBatchable(tempAccountIdentifier: String, setupPin: String, optionalArgsProvider: ((Matter.AccountLoginTrait.LoginCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

  • Whether the device supports the logout command for this trait.

    Declaration

    Swift

    var supportsLogoutCommand: Bool { get }

  • Instruct the content app to clear the current user account and end the user session.

    Declaration

    Swift

    func logout(optionalArgsProvider: ((Matter.AccountLoginTrait.LogoutCommand.OptionalArgs) -> Void)? = nil) async throws

  • The batchable version of logout command above.

    See also

    logout

    Declaration

    Swift

    func logoutBatchable(optionalArgsProvider: ((Matter.AccountLoginTrait.LogoutCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>