FaceLibrary

class FaceLibrary : PlatformTrait, FaceLibraryTrait.Attributes, Updatable

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

Summary

Nested types

Descriptor enum for this trait's attributes.

Public functions
suspend List<FaceLibraryTrait.FaceInstance>
suspend List<FaceLibraryTrait.Face>
getFaces(
    faceIds: FaceLibraryTrait.FaceIds?,
    faceCategories: FaceLibraryTrait.FaceCategories?
)
suspend List<FaceLibraryTrait.FaceByInstance>
getFacesByInstances(faceInstanceIdsList: List<String>)
suspend FaceLibraryTrait.GiveFaceFeedback.GiveFaceFeedbackResponse
giveFaceFeedback(
    faceInstancePositiveFeedback: FaceLibraryTrait.FaceInstancePositiveFeedback?,
    faceInstanceNegativeFeedback: FaceLibraryTrait.FaceInstanceNegativeFeedback?
)
suspend FaceLibraryTrait.MergeFaces.MergeFacesResponse
mergeFaces(
    mergedFaceId: String?,
    faceIdsToMergeList: List<String>,
    Name: String?
)
suspend FaceLibraryTrait.MoveFaceInstances.MoveFaceInstancesResponse
moveFaceInstances(
    faceId: String?,
    faceInstanceIdsList: List<String>,
    Name: String?
)
suspend FaceLibraryTrait.RemoveFaceInstances.RemoveFaceInstancesResponse
removeFaceInstances(faceInstanceIdsList: List<String>)
suspend FaceLibraryTrait.RemoveFaces.RemoveFacesResponse
removeFaces(faceIdsList: List<String>)
suspend FaceLibraryTrait.RemoveLibrary.RemoveLibraryResponse
open suspend FaceLibrary
update(optimisticReturn: (FaceLibrary) -> Unit, init: FaceLibraryTrait.MutableAttributes.() -> Unit)

Updater function to modify any writable attributes.
suspend FaceLibraryTrait.UpdateFace.UpdateFaceResponse
updateFace(
    id: String?,
    Name: String?,
    category: FaceLibraryTrait.FaceCategory?
)

Public properties
open TraitFactory<FaceLibrary>

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.FaceLibraryTrait.Attributes
open FaceLibraryTrait.FaceLibraryStatus?
From com.google.home.google.PlatformTrait
open Trait.TraitMetadata
PlatformTraitClient

Public functions

getFaceInstances

suspend fun getFaceInstances(faceId: String? = null): List<FaceLibraryTrait.FaceInstance>

getFaces

suspend fun getFaces(
    faceIds: FaceLibraryTrait.FaceIds? = null,
    faceCategories: FaceLibraryTrait.FaceCategories? = null
): List<FaceLibraryTrait.Face>

getFacesByInstances

suspend fun getFacesByInstances(faceInstanceIdsList: List<String>): List<FaceLibraryTrait.FaceByInstance>

giveFaceFeedback

suspend fun giveFaceFeedback(
    faceInstancePositiveFeedback: FaceLibraryTrait.FaceInstancePositiveFeedback? = null,
    faceInstanceNegativeFeedback: FaceLibraryTrait.FaceInstanceNegativeFeedback? = null
): FaceLibraryTrait.GiveFaceFeedback.GiveFaceFeedbackResponse

mergeFaces

suspend fun mergeFaces(
    mergedFaceId: String? = null,
    faceIdsToMergeList: List<String>,
    Name: String? = null
): FaceLibraryTrait.MergeFaces.MergeFacesResponse

moveFaceInstances

suspend fun moveFaceInstances(
    faceId: String? = null,
    faceInstanceIdsList: List<String>,
    Name: String? = null
): FaceLibraryTrait.MoveFaceInstances.MoveFaceInstancesResponse

removeFaceInstances

suspend fun removeFaceInstances(faceInstanceIdsList: List<String>): FaceLibraryTrait.RemoveFaceInstances.RemoveFaceInstancesResponse

removeFaces

suspend fun removeFaces(faceIdsList: List<String>): FaceLibraryTrait.RemoveFaces.RemoveFacesResponse

removeLibrary

suspend fun removeLibrary(): FaceLibraryTrait.RemoveLibrary.RemoveLibraryResponse

update

open suspend fun update(optimisticReturn: (FaceLibrary) -> Unit, init: FaceLibraryTrait.MutableAttributes.() -> Unit): FaceLibrary

Updater function to modify any writable attributes.

updateFace

suspend fun updateFace(
    id: String? = null,
    Name: String? = null,
    category: FaceLibraryTrait.FaceCategory? = null
): FaceLibraryTrait.UpdateFace.UpdateFaceResponse

Public properties

factory

open val factory: TraitFactory<FaceLibrary>