GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode
Table of Contents ▼
Jump to a specific part of the page:
Description
Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17
Attributes List
This module has the following attributes (case-insensitive ascending order):
Attributes
-
aogContextId
(type:list(String.t)
, default:nil
)
- List of AOG app context ids that are linked to this device. These apps will have access to the structure information for the device. -
aogInvocationPhrase
(type:String.t
, default:nil
)
- Invocation phrase for hotel's AoG action. Used for ZS promotion card and "talk to my hotel" rewrites. Setting this to an empty value will mark it unset. -
branding
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding
, default:nil
)
- -
cardSettings
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings
, default:nil
)
- -
deviceClearRequest
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
, default:nil
)
- The time when we received a request to reset the device. -
dialogTtlOverrideMicros
(type:String.t
, default:nil
)
- Should the dialog have a shorter ttl. See go/ipp-consumer-prd#heading=h.ibu9b1ysdl4t and go/interpreter-device-clear#bookmark=id.hw8ey1bzjadn for context. -
enterpriseId
(type:String.t
, default:nil
)
- Identifier for the enterprise which owns the device. Setting this to an empty value will mark it unset. -
hospitalityModeEnabled
(type:boolean()
, default:nil
)
- Indicates whether this device is in the hospitality mode. -
lastDeviceClear
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
, default:nil
)
- Last time the device was cleared and placed in hospitality mode. Will be set when the switch is toggled on and reset when a guest checks out. On the device this triggers removing alarms, timers, etc. -
lastModifiedTimestamp
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
, default:nil
)
- Indicates when hospitality settings were last updated. -
lastWelcomed
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
, default:nil
)
- Last time the welcome message was played for the guest. If last_welcomed < welcome_request, the message should be replayed and this time set. -
manualResetRequired
(type:boolean()
, default:nil
)
- Indicates whether or not the device must be reset manually (by voice or touch), as opposed to being automatically reset. go/hospitality-manual-reset -
promotedLanguages
(type:list(String.t)
, default:nil
)
- In order promoted languages for interpreter devices. This represents languages by BCP-47 language strings, such as "en", "en-US", "fr", "fr-CA", "sr-Latn", "zh-Hans-CN", "zh-Hant-HK",etc. -
type
(type:String.t
, default:nil
)
- -
verbalResetSupported
(type:boolean()
, default:nil
)
- Whether we allow users to initiate clearing the device verbally. We generally allow this for private devices and not for public ones. -
welcomeRequest
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
, default:nil
)
- The time when we received a request to welcome the user.
Type
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode{
aogContextId: [String.t()] | nil,
aogInvocationPhrase: String.t() | nil,
branding: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding.t() | nil,
cardSettings: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings.t() | nil,
deviceClearRequest: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
dialogTtlOverrideMicros: String.t() | nil,
enterpriseId: String.t() | nil,
hospitalityModeEnabled: boolean() | nil,
lastDeviceClear: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastModifiedTimestamp: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastWelcomed: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
manualResetRequired: boolean() | nil,
promotedLanguages: [String.t()] | nil,
type: String.t() | nil,
verbalResetSupported: boolean() | nil,
welcomeRequest: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil
}
aogContextId: [String.t()] | nil,
aogInvocationPhrase: String.t() | nil,
branding: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding.t() | nil,
cardSettings: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings.t() | nil,
deviceClearRequest: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
dialogTtlOverrideMicros: String.t() | nil,
enterpriseId: String.t() | nil,
hospitalityModeEnabled: boolean() | nil,
lastDeviceClear: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastModifiedTimestamp: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastWelcomed: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
manualResetRequired: boolean() | nil,
promotedLanguages: [String.t()] | nil,
type: String.t() | nil,
verbalResetSupported: boolean() | nil,
welcomeRequest: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil
}
Function
@spec decode(struct(), keyword()) :: struct()Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode