Variable SharedActionsConst

Type Declaration

• actions: Record<string, SharedActionHandler[]>

• add: function

  • add(action_id: string, handler: SharedActionHandler): Deletable

    Add a method to handle a specific use case of a shared action

    Parameters

    • action_id: string

      Action ID

    • handler: SharedActionHandler

      Handler options

    Returns Deletable

• condition: function

  • condition(action_id: string): boolean

    Check if there is an active and available handler in the current situation for a shared action

    Parameters

    • action_id: string

    Returns boolean

• find: function

  • find(action_id: string, event?: Event, context?: any): SharedActionHandler

    Find the active handler in the current situation for a shared action

    Parameters

    • action_id: string
    • Optionalevent: Event
    • Optionalcontext: any

    Returns SharedActionHandler

• run: function

  • run(action_id: string, event?: Event, context?: any): boolean

    Run the active handler for a specific subject manually

    Parameters

    • action_id: string

      Action ID

    • Optionalevent: Event

      Event that triggered the interaction

    • Optionalcontext: any

      Optional context variable

    Returns boolean

• runSpecific: function

  • runSpecific(
        action_id: string,
        subject: string,
        event?: Event,
        context?: any,
        force?: boolean,
    ): boolean

    Run a specific handler manually

    Parameters

    • action_id: string

      Action ID

    • subject: string

      Subject to run on

    • Optionalevent: Event

      Event that triggered the interaction

    • Optionalcontext: any

      Optional context variable

    • Optionalforce: boolean

      Force the specified handler to run and ignore its condition

    Returns boolean