Chat
Chat
Chat controls layout density, the thread header, composer disclaimer, hash routing, and voice input.
The default for chat is on.
Voice input defaults to off.
Hash routing lives here, not on history.
Prerequisites
| Item | Requirement |
|---|---|
| Host page | Serves HTTPS and can load a third-party script |
| Persona | loyalty-concierge |
| Bundle global | window.AugeoChatSdkLoyaltyConcierge |
Load a pinned production loyalty bundle first.
Read Capabilities for the shared true / false / object contract.
Values
| Value | Effect |
|---|---|
| omitted | Chat on with defaults |
true | Chat on with defaults |
false | Hides header and disclaimer. Compact off |
| object | Chat on with overrides |
hashRouting is read only from an options object.
chat: false leaves hash routing at its default true.
Parameters
| Parameter | Default | Type |
|---|---|---|
compact | false | boolean |
header | shown | false or { title?, subtitle? } |
disclaimer | consent agreement | string or false |
hashRouting | true | boolean |
voiceInput | false | boolean |
compact
false uses the default new-chat spacing.
true uses denser padding and hides the composer disclaimer.
capabilities: { chat: { compact: true } }The new-chat opener sits in a tighter band.
The composer notice is hidden even when disclaimer is omitted.
Compact layout also hides starter cards even when starterCards is true.
header
Omit header to keep the thread header.
Pass false to hide it.
Pass { title?, subtitle? } to set header copy.
capabilities: { chat: { header: false } }The shared identity header is hidden.
capabilities: {
chat: { header: { title: 'Help', subtitle: 'Rewards' } },
}The header shows Help and Rewards.
Blank title or subtitle strings are dropped.
disclaimer
Omit disclaimer to show the consent agreement.
Set capabilities.privacy.policy.url to link its Privacy Policy label.
Pass capabilities.privacy.consent: false for a composer link without the consent gate.
Read Privacy for missing-link behavior.
That notice is hidden in compact layout.
Pass a string to replace the notice.
Pass false to hide it.
capabilities: { chat: { disclaimer: 'Host support copy.' } }The composer shows Host support copy. instead of the consent agreement.
capabilities: { chat: { disclaimer: false } }The composer notice is hidden.
hashRouting
true uses hash routes.
The page hash updates as the member moves between threads.
false uses in-memory routes.
The page hash does not change.
const { AugeoAssistant } = window.AugeoChatSdkLoyaltyConcierge;
new AugeoAssistant({
container: '#chat-host',
auth: { getToken: () => bearerToken },
capabilities: { chat: { hashRouting: true } },
});Thread navigation writes the route into the URL hash.
new AugeoAssistant({
container: '#chat-host',
auth: { getToken: () => bearerToken },
capabilities: { chat: { hashRouting: false } },
});Thread navigation stays in memory.
Host hashes are unchanged.
history: false does not change this setting.
voiceInput
false hides the microphone.
true opts the host into voice input.
voiceInput is read only from an options object.
chat: true leaves voice input off.
capabilities: { chat: { voiceInput: true } }The microphone shows only when host chat.voiceInput and the Augeo server switch are both on.
The host cannot turn that server switch on from the constructor.
A missing or failed server switch hides the microphone.
The first microphone tap shows a notice before recognition starts.
Recognition does not start until the member accepts that notice.
Browser microphone permission is separate from notice acceptance.
The browser still asks for microphone permission after acceptance.
An accepted notice is saved in host-origin browser localStorage.
The key is augeo:voice-notice-accepted.
The SDK does not store voice audio. The SDK does not send voice audio. Recognized words are submitted through the normal text-message path. The browser speech service may send audio off the device. Chrome, for example, sends that audio to Google.
When both switches are on and the browser has no speech recognition, the microphone is disabled. Tapping that disabled microphone shows that voice is unavailable. Typing remains available in an unsupported browser.
A message sent from voice sets inputMethod: 'voice' in data.occurrence on com.augeo.conversation.message.sent.
Related pages
| Topic | Page |
|---|---|
| Product scope | Overview |
| Constructor fields | Configuration |
| Placement | Surfaces |
| Capability list | Capabilities |
| History | History |
| Privacy | Privacy |
| Message actions | Message actions |
| Suggestions | Suggestions |
| Wishlist | Wishlist |
| Event options | Event options |
| Analytics | Analytics |
| Support | Support |
| Recovery | Recovery |
| Devtools | Devtools |
| DOM events | Events |
| Public types | API |