AssistantApiCoreTypesSurfaceIdentity

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity

Table of Contents ▼

Jump to a specific part of the page:

Description

The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. deviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId, default: nil)
    - The identifier of the device.
  2. legacySurfaceType (type: String.t, default: nil)
    - DEPRECATED: The legacy device's surface type enum. NOTE: Prefer using the ontological surface_type field above. If you need to access the legacy surface type, please file a bug and add it in your code to migrate to ontological surface type.
  3. surfaceType (type: String.t, default: nil)
    - The device's surface type. The types are defined at google3/assistant/api/core_types/surfaces.gcl. For more details, refer to go/ontologicalize-surface-type.
  4. surfaceTypeString (type: String.t, default: nil)
    - DEPRECATED. The legacy device's surface type string. NOTE: Prefer using the ontological surface_type field. The device's surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string.
  5. surfaceVersion (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion, default: nil)
    - The version of the surface/client. This is different from the Conversation protocol version.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity{
deviceId: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
legacySurfaceType: String.t() | nil,
surfaceType: String.t() | nil,
surfaceTypeString: String.t() | nil,
surfaceVersion: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity