AttachedResultsActions

This is for:

Developer
Note

This component was introduced in version 2.13.1.

See Dispatch Actions.

Loader Function

loadAttachedResultsActions

Loads the attachedResults reducer and returns possible action creators.

Parameters

  • engine: InsightEngine

    The headless engine.

Returns AttachedResultsActionCreators

AttachedResultsActionCreators

setAttachedResults

Creates an action that sets the attached results to a record.

Parameters

Returns PayloadAction<SetAttachedResultsActionCreatorPayload>: A dispatchable action.

AttachedResult

Properties

  • caseId: string

    The Id of the record (Case) the result is attached to.

  • resultUrl: string

    The url of the attached result.

  • title: string

    The title of the attached result.

  • articleLanguage?: string

    Specifies the language of an attached Salesforce Knowledge Article.

  • articlePublishStatus?: string

    Specifies the publish status of an attached Salesforce Knowledge Article.

  • articleVersionNumber?: string

    Specifies the version number of an attached Salesforce Knowledge Article.

  • knowledgeArticleId?: string

    The Id of an attached Salesforce Knowledge Article.

  • permanentId?: string

    The permanentId, the identifier of an attached result.

  • source?: string

    The source name where the attached result comes from.

  • uriHash?: string

    The uriHash of the attached result.

SetAttachedResultsActionCreatorPayload

Properties

  • results: AttachedResult[]

    The array of all attached results.

  • loading?: boolean

    Is the data for Attached Results currently loading.