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


updateNote

Update the last note of a specified interaction; this method does not change notes other than the last one.  If the interactionId isn't specified, the method will set the note for the currently active interaction.

Request

Syntax

updateNote(note: string, interactionId?: string): Promise<OperationResult<null>>

Parameters

Parameter Parameter Values Data Type Optional/Required Description
note String Required The note you want to update for the interaction.
interactionId String Optional The specific interaction ID for the interaction the updated note applies to.

Example Request

    updateNoteButton.onclick = () => {

        const note = noteInput.value

        const itemId = notesInteractionIdInput.value

        adApi.updateNote(note, itemId)

    }

Return Value

null

< Previous | Next >