​

Interface: CharAgentProps

React props for the CharAgent wrapper. Auth contract:

• publishableKey required
• idToken optional

​

Extends

• Omit<HTMLAttributes<CharAgentElement>, "children" | "onError">

​

Properties

​

apiBase?

optional apiBase: string

---

​

displayMode?

optional displayMode: CharDisplayMode

---

​

enableDebugTools?

optional enableDebugTools: boolean

---

​

idToken?

optional idToken: string

---

​

onCharClose()?

optional onCharClose: () => void

​

Returns

void

---

​

onCharError()?

optional onCharError: (detail) => void

​

Parameters

detail

CharErrorDetail

​

Returns

void

---

​

onCharInitialized()?

optional onCharInitialized: () => void

​

Returns

void

---

​

onCharOpenLink()?

optional onCharOpenLink: (detail) => void

​

Parameters

detail

CharOpenLinkDetail

​

Returns

void

---

​

onCharRequestDisplayMode()?

optional onCharRequestDisplayMode: (detail) => void

​

Parameters

detail

CharRequestDisplayModeDetail

​

Returns

void

---

​

onCharSizeChanged()?

optional onCharSizeChanged: (detail) => void

​

Parameters

detail

CharSizeChangedDetail

​

Returns

void

---

​

publishableKey

publishableKey: string