Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Endpoints

Hierarchy

  • Endpoints

Index

Methods

Methods

get

  • get(params: { resource: string; tech: string }, callback: (err: Error, endpoint: Endpoint) => void): void
  • get(callback: (err: Error, endpoint: Endpoint) => void): void
  • get(params?: { resource: string; tech: string }): Promise<Endpoint>

  • Details for an endpoint.

    Parameters

    • params: { resource: string; tech: string }
      • resource: string
      • tech: string
    • callback: (err: Error, endpoint: Endpoint) => void
        • (err: Error, endpoint: Endpoint): void

        • Parameters

          Returns void

    Returns void

  • Details for an endpoint.

    Parameters

    • callback: (err: Error, endpoint: Endpoint) => void
        • (err: Error, endpoint: Endpoint): void

        • Parameters

          Returns void

    Returns void

  • Details for an endpoint.

    Parameters

    • Optional params: { resource: string; tech: string }
      • resource: string
      • tech: string

    Returns Promise<Endpoint>

list

  • list(callback: (err: Error, endpoints: Endpoint[]) => void): void
  • list(): Promise<Endpoint[]>

  • List all endpoints.

    Parameters

    • callback: (err: Error, endpoints: Endpoint[]) => void
        • (err: Error, endpoints: Endpoint[]): void

        • Parameters

          Returns void

    Returns void

  • List all endpoints.

    Returns Promise<Endpoint[]>

listByTech

  • listByTech(params: { tech: string }, callback: (err: Error, endpoints: Endpoint[]) => void): void
  • listByTech(callback: (err: Error, endpoints: Endpoint[]) => void): void
  • listByTech(params?: { tech: string }): Promise<Endpoint[]>

  • List available endoints for a given endpoint technology.

    Parameters

    • params: { tech: string }
      • tech: string
    • callback: (err: Error, endpoints: Endpoint[]) => void
        • (err: Error, endpoints: Endpoint[]): void

        • Parameters

          Returns void

    Returns void

  • List available endoints for a given endpoint technology.

    Parameters

    • callback: (err: Error, endpoints: Endpoint[]) => void
        • (err: Error, endpoints: Endpoint[]): void

        • Parameters

          Returns void

    Returns void

  • List available endoints for a given endpoint technology.

    Parameters

    • Optional params: { tech: string }
      • tech: string

    Returns Promise<Endpoint[]>

sendMessage

  • sendMessage(params: { body?: string; from: string; to: string; variables?: Containers }, callback: (err: Error) => void): void
  • sendMessage(params: { body?: string; from: string; to: string; variables?: Containers }): Promise<void>

  • Send a message to some technology URI or endpoint.

    Parameters

    • params: { body?: string; from: string; to: string; variables?: Containers }
      • Optional body?: string
      • from: string

        The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.

      • to: string

        The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.

      • Optional variables?: Containers
    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Send a message to some technology URI or endpoint.

    Parameters

    • params: { body?: string; from: string; to: string; variables?: Containers }
      • Optional body?: string
      • from: string

        The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.

      • to: string

        The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.

      • Optional variables?: Containers

    Returns Promise<void>

sendMessageToEndpoint

  • sendMessageToEndpoint(params: { body?: string; from: string; resource: string; tech: string; variables?: Containers }, callback: (err: Error) => void): void
  • sendMessageToEndpoint(params: { body?: string; from: string; resource: string; tech: string; variables?: Containers }): Promise<void>

  • Send a message to some endpoint in a technology.

    Parameters

    • params: { body?: string; from: string; resource: string; tech: string; variables?: Containers }
      • Optional body?: string
      • from: string

        The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.

      • resource: string
      • tech: string
      • Optional variables?: Containers
    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Send a message to some endpoint in a technology.

    Parameters

    • params: { body?: string; from: string; resource: string; tech: string; variables?: Containers }
      • Optional body?: string
      • from: string

        The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.

      • resource: string
      • tech: string
      • Optional variables?: Containers

    Returns Promise<void>

Generated using TypeDoc