GroupManagement

class GroupManagement : PlatformTrait, GroupManagementTrait.Attributes


API for the GroupManagement trait, which is used to create, delete, and modify groups.

Summary

Public functions

suspend GroupManagementTrait.AddGroupMembers.AddGroupMembersResponse
addGroupMembers(
    groupObjectId: String?,
    memberDeviceObjectIdsList: List<String>
)

Add members to a device group.

suspend String?
createCastSpeakerGroup(
    Name: String?,
    memberDeviceObjectIdsList: List<String>
)

Create a speaker group (CastSpeakerGroup) with the option to specify members by device id.

suspend String?
createGroup(
    Name: String?,
    memberDeviceObjectIdsList: List<String>,
    policyId: String?
)

Create a group with the option to specify members by device id.

suspend String?
createUserDefinedGroup(
    Name: String?,
    memberDeviceObjectIdsList: List<String>
)

Create a user-defined group with the option to specify members by device id.

suspend GroupManagementTrait.DeleteGroup.DeleteGroupResponse
deleteGroup(groupObjectId: String?)

Delete a device group.

suspend GroupManagementTrait.RemoveAllGroupMembers.RemoveAllGroupMembersResponse
removeAllGroupMembers(groupObjectId: String?)

Command to remove all members from a device group.

suspend GroupManagementTrait.RemoveGroupMembers.RemoveGroupMembersResponse
removeGroupMembers(
    groupObjectId: String?,
    memberDeviceObjectIdsList: List<String>
)

Command to remove members from a device group.

Public properties

open TraitFactory<GroupManagement>

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)

Public functions

addGroupMembers

suspend fun addGroupMembers(
    groupObjectId: String? = null,
    memberDeviceObjectIdsList: List<String>
): GroupManagementTrait.AddGroupMembers.AddGroupMembersResponse

Add members to a device group.

createCastSpeakerGroup

suspend fun createCastSpeakerGroup(
    Name: String? = null,
    memberDeviceObjectIdsList: List<String>
): String?

Create a speaker group (CastSpeakerGroup) with the option to specify members by device id.

createGroup

suspend fun createGroup(
    Name: String? = null,
    memberDeviceObjectIdsList: List<String>,
    policyId: String? = null
): String?

Create a group with the option to specify members by device id.

createUserDefinedGroup

suspend fun createUserDefinedGroup(
    Name: String? = null,
    memberDeviceObjectIdsList: List<String>
): String?

Create a user-defined group with the option to specify members by device id.

deleteGroup

suspend fun deleteGroup(groupObjectId: String? = null): GroupManagementTrait.DeleteGroup.DeleteGroupResponse

Delete a device group.

removeAllGroupMembers

suspend fun removeAllGroupMembers(groupObjectId: String? = null): GroupManagementTrait.RemoveAllGroupMembers.RemoveAllGroupMembersResponse

Command to remove all members from a device group.

removeGroupMembers

suspend fun removeGroupMembers(
    groupObjectId: String? = null,
    memberDeviceObjectIdsList: List<String>
): GroupManagementTrait.RemoveGroupMembers.RemoveGroupMembersResponse

Command to remove members from a device group.

Public properties

factory

open val factory: TraitFactory<GroupManagement>