Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TriggerService

Hierarchy

  • TriggerService

Index

Constructors

constructor

Methods

addListener

  • addListener(listener: any): void
  • Adds a trigger listener that will be called back when triggers are added and removed.

    Parameters

    • listener: any

    Returns void

addTrigger

  • addTrigger(subject: any, condition: any, extraParams: any, listener: any): Trigger
  • Add a new trigger for the current user.

    Parameters

    • subject: any

      the rttp subject of this trigger.

    • condition: any

      the trigger condition, for more details on the format of the condition string, please see the StreamLink Overview document.

    • extraParams: any

      a map of extra parameters to be added to the trigger.

    • listener: any

      a ResultListener that will be called back to notify the user code of the result of this operation.

    Returns Trigger

    the trigger that has been created.

disableTrigger

  • disableTrigger(trigger: any, listener: any): void
  • Disables a trigger in the system.

    Parameters

    • trigger: any

      the Trigger that should be Disabled.

    • listener: any

      a ResultListener that will be called back to notify the user code of the result of this operation.

    Returns void

enableTrigger

  • enableTrigger(trigger: any, listener: any): void
  • Enables a trigger from in system.

    Parameters

    • trigger: any

      the Trigger that should be enabled.

    • listener: any

      a ResultListener that will be called back to notify the user code of the result of this operation.

    Returns void

removeListener

  • removeListener(listener: any): void
  • Removes a previously added trigger listener, callbacks to this listener will be stopped.

    Parameters

    • listener: any

    Returns void

removeTrigger

  • removeTrigger(trigger: any, listener: any): void
  • Removes a trigger from the system.

    Parameters

    • trigger: any

      the Trigger that should be removed.

    • listener: any

      a ResultListener that will be called back to notify the user code of the result of this operation.

    Returns void

Generated using TypeDoc