Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Events

Hierarchy

  • Events

Index

Methods

Methods

eventWebsocket

  • eventWebsocket(params: { app: string | string[]; subscribeAll?: boolean }, callback: (err: Error, message: Message) => void): void
  • eventWebsocket(params: { app: string | string[]; subscribeAll?: boolean }): Promise<Message>

  • WebSocket connection for events.

    Parameters

    • params: { app: string | string[]; subscribeAll?: boolean }
      • app: string | string[]

        Applications to subscribe to.

      • Optional subscribeAll?: boolean
    • callback: (err: Error, message: Message) => void
        • (err: Error, message: Message): void

        • Parameters

          Returns void

    Returns void

  • WebSocket connection for events.

    Parameters

    • params: { app: string | string[]; subscribeAll?: boolean }
      • app: string | string[]

        Applications to subscribe to.

      • Optional subscribeAll?: boolean

    Returns Promise<Message>

userEvent

  • userEvent(params: { application: string; eventName: string; source?: string | string[]; variables?: Containers }, callback: (err: Error) => void): void
  • userEvent(params: { application: string; eventName: string; source?: string | string[]; variables?: Containers }): Promise<void>

  • Generate a user event.

    Parameters

    • params: { application: string; eventName: string; source?: string | string[]; variables?: Containers }
      • application: string

        The name of the application that will receive this event.

      • eventName: string

        Event name.

      • Optional source?: string | string[]
      • Optional variables?: Containers
    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Generate a user event.

    Parameters

    • params: { application: string; eventName: string; source?: string | string[]; variables?: Containers }
      • application: string

        The name of the application that will receive this event.

      • eventName: string

        Event name.

      • Optional source?: string | string[]
      • Optional variables?: Containers

    Returns Promise<void>

Generated using TypeDoc