Interface CaseAssistAnalyticsActionCreators

The Case Assist analytics action creators.

interface CaseAssistAnalyticsActionCreators {
    logAbandonCase(): CaseAssistAction;
    logCaseNextStage(options?: NextStageOptions): CaseAssistAction;
    logCaseStart(): CaseAssistAction;
    logClassificationClick(classificationId: string): CaseAssistAction;
    logCreateCase(): CaseAssistAction;
    logDocumentSuggestionClick(suggestionId: string): CaseAssistAction;
    logDocumentSuggestionRating(
        suggestionId: string,
        rating: number,
    ): CaseAssistAction;
    logQuickviewDocumentSuggestionClick(suggestionId: string): CaseAssistAction;
    logSolveCase(): CaseAssistAction;
    logUpdateCaseField(fieldName: string): CaseAssistAction;
}

Index

Methods

logAbandonCase logCaseNextStage logCaseStart logClassificationClick logCreateCase logDocumentSuggestionClick logDocumentSuggestionRating logQuickviewDocumentSuggestionClick logSolveCase logUpdateCaseField

Methods

logAbandonCase

logAbandonCase(): CaseAssistAction
Creates a Case Assist event for when the user leaves.

Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:61

logCaseNextStage

logCaseNextStage(options?: NextStageOptions): CaseAssistAction
Creates a Case Assist event for when the user moves to the next stage.
Parameters
- Optionaloptions: NextStageOptions
  Options of the event.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:40

logCaseStart

logCaseStart(): CaseAssistAction
Creates a Case Assist event for when the user enters the interface.

Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:32

logClassificationClick

logClassificationClick(classificationId: string): CaseAssistAction
Creates a Case Assist event for when the user selects a classification suggestion.
Parameters
- classificationId: string
  The unique identifier of the target classification.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:77

logCreateCase

logCreateCase(): CaseAssistAction
Creates a Case Assist event for when the user creates a case.

Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:47

logDocumentSuggestionClick

logDocumentSuggestionClick(suggestionId: string): CaseAssistAction
Creates a Case Assist event for when the user selects a document suggestion.
Parameters
- suggestionId: string
  The unique identifier of the target document.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:85

logDocumentSuggestionRating

logDocumentSuggestionRating(
suggestionId: string,
rating: number,
): CaseAssistAction
Creates a Case Assist event for when the user rates a document suggestion.
Parameters
- suggestionId: string
  The unique identifier of the target document.
- rating: number
  The rating.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:102

logQuickviewDocumentSuggestionClick

logQuickviewDocumentSuggestionClick(suggestionId: string): CaseAssistAction
Creates a Case Assist event for when the user previews a document suggestion from the quickview.
Parameters
- suggestionId: string
  The unique identifier of the target document.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:93

logSolveCase

logSolveCase(): CaseAssistAction
Creates a Case Assist event for when the case is solved.

Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:54

logUpdateCaseField

logUpdateCaseField(fieldName: string): CaseAssistAction
Creates a Case Assist event for when the user updates a field.
Parameters
- fieldName: string
  The target field name.
Returns CaseAssistAction
A dispatchable action.
- Defined in packages/headless/src/features/case-assist/case-assist-analytics-actions-loader.ts:69

Interface CaseAssistAnalyticsActionCreators

Index

Methods

Methods

logAbandonCase

Returns CaseAssistAction

logCaseNextStage

Parameters

Returns CaseAssistAction

logCaseStart

Returns CaseAssistAction

logClassificationClick

Parameters

Returns CaseAssistAction

logCreateCase

Returns CaseAssistAction

logDocumentSuggestionClick

Parameters

Returns CaseAssistAction

logDocumentSuggestionRating

Parameters

Returns CaseAssistAction

logQuickviewDocumentSuggestionClick

Parameters

Returns CaseAssistAction

logSolveCase

Returns CaseAssistAction

logUpdateCaseField

Parameters

Returns CaseAssistAction

Settings

On This Page