Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Applications

Hierarchy

  • Applications

Index

Methods

filter

  • Filter application events types. Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated: "allowed" - Specifies an allowed list of event types "disallowed" - Specifies a disallowed list of event types Further, each of those keys value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value: "type" - The type name of the event to filter The value must be the string name (case sensitive) of the event type that needs filtering. For example: { "allowed": [ { "type": "StasisStart" }, { "type": "StasisEnd" } ] } As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent. The following rules apply: * If the body is empty, both the allowed and disallowed filters are set empty. * If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty). * If only one list type is given then only that type is set. The other type is not updated. * An empty "allowed" list means all events are allowed. * An empty "disallowed" list means no events are disallowed. * Disallowed events take precedence over allowed events if the event type is specified in both lists.

    Parameters

    Returns void

  • Filter application events types. Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated: "allowed" - Specifies an allowed list of event types "disallowed" - Specifies a disallowed list of event types Further, each of those keys value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value: "type" - The type name of the event to filter The value must be the string name (case sensitive) of the event type that needs filtering. For example: { "allowed": [ { "type": "StasisStart" }, { "type": "StasisEnd" } ] } As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent. The following rules apply: * If the body is empty, both the allowed and disallowed filters are set empty. * If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty). * If only one list type is given then only that type is set. The other type is not updated. * An empty "allowed" list means all events are allowed. * An empty "disallowed" list means no events are disallowed. * Disallowed events take precedence over allowed events if the event type is specified in both lists.

    Parameters

    Returns Promise<Application>

get

  • get(params: { applicationName: string }, callback: (err: Error, application: Application) => void): void
  • get(params: { applicationName: string }): Promise<Application>
  • Get details of an application.

    Parameters

    • params: { applicationName: string }
      • applicationName: string

        Applications name.

    • callback: (err: Error, application: Application) => void

    Returns void

  • Get details of an application.

    Parameters

    • params: { applicationName: string }
      • applicationName: string

        Applications name.

    Returns Promise<Application>

list

  • List all applications.

    Parameters

    • callback: (err: Error, applications: Application[]) => void
        • Parameters

          Returns void

    Returns void

  • List all applications.

    Returns Promise<Application[]>

subscribe

  • subscribe(params: { applicationName: string; eventSource: string | string[] }, callback: (err: Error, application: Application) => void): void
  • subscribe(params: { applicationName: string; eventSource: string | string[] }): Promise<Application>
  • Subscribe an application to a event source. Returns the state of the application after the subscriptions have changed.

    Parameters

    • params: { applicationName: string; eventSource: string | string[] }
      • applicationName: string

        Applications name.

      • eventSource: string | string[]

        URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}.

    • callback: (err: Error, application: Application) => void

    Returns void

  • Subscribe an application to a event source. Returns the state of the application after the subscriptions have changed.

    Parameters

    • params: { applicationName: string; eventSource: string | string[] }
      • applicationName: string

        Applications name.

      • eventSource: string | string[]

        URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}.

    Returns Promise<Application>

unsubscribe

  • unsubscribe(params: { applicationName: string; eventSource: string | string[] }, callback: (err: Error, application: Application) => void): void
  • unsubscribe(params: { applicationName: string; eventSource: string | string[] }): Promise<Application>
  • Unsubscribe an application from an event source. Returns the state of the application after the subscriptions have changed.

    Parameters

    • params: { applicationName: string; eventSource: string | string[] }
      • applicationName: string

        Applications name.

      • eventSource: string | string[]

        URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}.

    • callback: (err: Error, application: Application) => void

    Returns void

  • Unsubscribe an application from an event source. Returns the state of the application after the subscriptions have changed.

    Parameters

    • params: { applicationName: string; eventSource: string | string[] }
      • applicationName: string

        Applications name.

      • eventSource: string | string[]

        URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}.

    Returns Promise<Application>

Generated using TypeDoc