Skip to main content
The help offer Hinto Signal holds for this tab’s journeys. It renders nothing: the host decides whether and how to show an offer. Actions never throw.

Methods

contact()

The customer chose Contact support. On started the offer is hidden and one message naming it is queued; open the conversation (runtime.open()) and the runtime sends it, joining the active conversation or starting one. The send accepts the offer on the server. A second call while that message is on its way answers unavailable and sends nothing.

Parameters

string
required

Returns

SupportContactOutcome

dismiss()

Hide the offer at once and record the dismissal.

Parameters

string
required

Returns

SupportOfferOutcome

refresh()

Send queued capture events, then read the offer now.

Returns

Promise<void>

show()

Claim the current offer before rendering it. Render only when this returns ok. Concurrent calls for one offer share one request.

Parameters

string
required

Returns

SupportOfferOutcome

snapshot()

Deep-frozen. The same object until the offer or its status changes.

Returns

SupportOfferSnapshot

subscribe()

Calls the listener at once with the current snapshot, then on every change.

Parameters

(snapshot: SupportOfferSnapshot) => void
required

Returns

() => void