StructureUserManagement

class StructureUserManagement : PlatformTrait, StructureUserManagementTrait.Attributes, Updatable

kotlin.Any
   ↳ com.google.home.google.PlatformTrait
     ↳ com.google.home.google.StructureUserManagement

Summary

Nested types

Descriptor enum for this trait's attributes.

Public functions
suspend StructureUserManagementTrait.CreateInvitation.CreateInvitationResponse
suspend List<StructureUserManagementTrait.InvitationDetails>
suspend List<StructureUserManagementTrait.UserMetadata>
suspend Unit
removeUser(structureId: String?, obfuscatedUserId: String?)
suspend Unit
revokeInvitation(invitationId: String?)
open suspend StructureUserManagement
update(
    optimisticReturn: (StructureUserManagement) -> Unit,
    init: StructureUserManagementTrait.MutableAttributes.() -> Unit
)

Updater function to modify any writable attributes.

Public properties
open TraitFactory<StructureUserManagement>

Inherited functions
From com.google.home.google.PlatformTrait
ObjectCommand
<REQUEST : Any?> createObjectCommand(
    commandId: String,
    request: PlatformTraitPayload<REQUEST>
)
suspend Unit
sendCommand(commandId: String)
suspend Unit
<REQUEST : Any?> sendCommand(
    commandId: String,
    request: PlatformTraitPayload<REQUEST>
)
suspend RESPONSE
<RESPONSE : Any?> sendCommand(
    commandId: String,
    responseParser: Parser<RESPONSE>
)
suspend RESPONSE
<REQUEST : Any?, RESPONSE : Any?> sendCommand(
    commandId: String,
    request: PlatformTraitPayload<REQUEST>,
    responseParser: Parser<RESPONSE>
)
suspend Unit
<T : Any?> write(parser: Parser<T>, attributes: T, useTimedInteraction: Boolean)

Inherited properties
From com.google.home.google.PlatformTrait
open Trait.TraitMetadata
PlatformTraitClient
From com.google.home.google.StructureUserManagementTrait.Attributes
open Boolean?

Indicates if a structure contains both LPAM (Federated Identity) and Gaia users.

Public functions

createInvitation

suspend fun createInvitation(
    intendedUserRole: StructureUserManagementTrait.UserRole? = null
): StructureUserManagementTrait.CreateInvitation.CreateInvitationResponse

listInvitations

suspend fun listInvitations(): List<StructureUserManagementTrait.InvitationDetails>

listUsersInStructure

suspend fun listUsersInStructure(structureId: String? = null): List<StructureUserManagementTrait.UserMetadata>

removeUser

suspend fun removeUser(structureId: String? = null, obfuscatedUserId: String? = null): Unit

revokeInvitation

suspend fun revokeInvitation(invitationId: String? = null): Unit

update

open suspend fun update(
    optimisticReturn: (StructureUserManagement) -> Unit,
    init: StructureUserManagementTrait.MutableAttributes.() -> Unit
): StructureUserManagement

Updater function to modify any writable attributes.

Public properties

factory

open val factory: TraitFactory<StructureUserManagement>