From Bright Pattern Documentation
< 5.19:AgentDesktop-client-side-javascript-api-specification
Revision as of 04:01, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19


completeInteraction

Completes an interaction with a provided ID (i.e., removes it from the user’s interactions list). If the interactionId isn't specified, this method will complete the currently active interaction.

Request

Syntax

completeInteraction(ineractionId?: string): Promise<OperationResult<null>>

Parameters

Parameter Parameter Values Data Type Optional/Required Description
interactionId String Optional The ID of the specific interaction that you wish to complete. If not specified, the active interaction will be used.

Example Request

    completeInteractionButton.onclick = () => {

        const itemId = completeInteractionIdInput.value

        adApi.completeInteraction(itemId)

    }

Return Value

null

< Previous | Next >