Class IFrameConnector

Hierarchy

Constructors

constructor

Properties

basePath connected host iframe? messages mid origin port queue secure DEFAULT_BASE_PATH HTTP_DOMAIN RESPONSE_HEADERS connections connectors style

Methods

doReceive doSend fromFormat load onLoad postMessage prepareRequest prepareResponse send toFormat create isUsable toUri

Constructors

constructor

Properties

Readonly basePath

basePath: string

The base path of the api endpoint

Private connected

connected: boolean = false

Readonly host

host: string

the host to connect to

Private Optional iframe

iframe?: HTMLIFrameElement

Private messages

messages: {
    [messageId: number]: Receiver;
}

Type declaration

Private mid

mid: number

Readonly origin

origin: string = ...

the origin do not contains the base path

Readonly port

port: number

the port to connect to

Private queue

queue: null | any[] = null

Readonly secure

secure: boolean

true for an secure connection

Static Readonly DEFAULT_BASE_PATH

DEFAULT_BASE_PATH: "/v1" = '/v1'

Static Readonly HTTP_DOMAIN

HTTP_DOMAIN: ".app.baqend.com" = '.app.baqend.com'

Static Readonly RESPONSE_HEADERS

RESPONSE_HEADERS: string[] = ...

An array of all exposed response headers

Static Readonly connections

connections: {
    [origin: string]: Connector;
} = {}

Array of all created connections

Type declaration

Static Readonly connectors

connectors: (Class<Connector> & typeof Connector)[] = []

Array of all available connector implementations

Static Readonly style

style: "width:1px;height:1px;position:absolute;top:-10px;left:-10px;" = 'width:1px;height:1px;position:absolute;top:-10px;left:-10px;'

Methods

doReceive

  • Parameters

    • event: MessageEvent<any>

    Returns void

doSend

fromFormat

  • Convert received data to the requested response entity type

    Returns

    Parameters

    • response: Response

      The response object

    • entity: any

      The received data

    • type: null | ResponseBodyType

      The requested response format

    Returns any

load

  • Parameters

    Returns void

onLoad

  • Returns void

postMessage

  • Parameters

    • msg: string

    Returns void

prepareRequest

prepareResponse

send

toFormat

  • Convert the message entity to the sendable representation

    Returns

    Parameters

    • message: Message

      The message to send

    Returns void

Static create

  • Returns

    Parameters

    • host: string

      or location

    • Optional port: number
    • Optional secure: boolean
    • Optional basePath: string

      The basepath of the api

    Returns Connector

Static isUsable

  • Indicates if this connector implementation is usable for the given host and port

    Returns

    Parameters

    • host: string
    • port: number
    • secure: boolean

    Returns boolean

Static toUri

  • Parameters

    • host: string
    • port: number
    • secure: boolean
    • basePath: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc