# AccountLogin


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface AccountLogin : AccountLoginTrait.Attributes, MatterTrait, AccountLoginCommands
```

<br />

*** ** * ** ***

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

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.LoggedOutEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.LoggedOut` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.LoggedOutEvent.EventFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this event's fields. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin#supports(com.google.home.matter.standard.AccountLogin.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin#supports(com.google.home.matter.standard.AccountLogin.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLogin#factory()` |

### Inherited functions

From [com.google.home.matter.standard.AccountLoginCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands) `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.GetSetupPinCommand.Response` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#getSetupPin(kotlin.String)(tempAccountIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

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.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.GetSetupPinCommand.Response>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#getSetupPinBatchable(kotlin.String)(tempAccountIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#getSetupPin(kotlin.String)` command.
`suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#login(kotlin.String,kotlin.String,kotlin.Function1)(
tempAccountIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
setupPin: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.LoginCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html
)`

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.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#loginBatchable(kotlin.String,kotlin.String,kotlin.Function1)(
tempAccountIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
setupPin: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.LoginCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html
)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#login(kotlin.String,kotlin.String,kotlin.Function1)` command.
`suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#logout(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.LogoutCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

Instruct the content app to clear the current user account and end the user session.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#logoutBatchable(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.LogoutCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginCommands#logout(kotlin.Function1)` command.
From [com.google.home.matter.standard.AccountLoginTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes) `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#getDescriptor()()`

Returns the descriptor for the struct.
`open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)`

Returns the value of the field for the given tag ID.
From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()`

### Inherited properties

From [com.google.home.matter.standard.AccountLoginTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes) `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#acceptedCommandList()`

A list of client-generated commands which are supported by this cluster server instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#attributeList()`

A list of the attribute IDs of the attributes supported by the cluster instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#clusterRevision()`

The revision of the server cluster specification supported by the cluster instance.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Feature` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#featureMap()`

Whether the server supports zero or more optional cluster features.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AccountLoginTrait.Attributes#generatedCommandList()`

A list of server-generated commands (server to client) which are supported by this cluster server instance.
From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()`

## Public functions

### supports

```
fun supports(attribute: AccountLogin.Attribute): Boolean
```

### supports

```
fun supports(command: AccountLogin.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<AccountLogin>
```