Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHelpProviderRequest

A request that Ultra-UI will send to an integration when users ask for help.

An example request that Ultra-UI will send to the integration when asking help on the base course page:

example

{
  type: 'event:event',
  eventType: 'help:request',
  correlationId: 'some-unique-id',
  helpUrl: 'http://help.blackboard.com/XXXXXXX',
  currentRouteName: 'base.courses'
}

Hierarchy

  • IHelpProviderRequest

Index

Properties

correlationId

correlationId: string

The id for the object that triggered the help request.

currentRouteName

currentRouteName: string

The current route that the user is on when asking for help.

eventType

eventType: "help:request"

Will always be HELP_REQUEST_TYPE.

helpUrl

helpUrl: string

The help url for the specific integration.

type

type: "event:event"

Will always be EVENT_OCCURRENCE_TYPE.

Generated using TypeDoc