Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmbedClient<T>

Wrapper for Looker embedded content. Provides a mechanism for creating the embedded content element, and for establishing two-way communication between the parent window and the embedded content.

Type Parameters

  • T

Hierarchy

  • EmbedClient

Index

Properties

Accessors

Methods

Properties

_client

_client: null | T = null

_connection

_connection: null | Promise<T> = null

Optional _cookielessApiToken

_cookielessApiToken?: null | string

Optional _cookielessApiTokenTtl

_cookielessApiTokenTtl?: null | number

_cookielessInitialized

_cookielessInitialized: boolean = false

Optional _cookielessNavigationToken

_cookielessNavigationToken?: null | string

Optional _cookielessNavigationTokenTtl

_cookielessNavigationTokenTtl?: null | number

Optional _cookielessSessionReferenceTokenTtl

_cookielessSessionReferenceTokenTtl?: null | number

_host

_host: null | ChattyHost = null

_hostBuilder

_hostBuilder: null | ChattyHostBuilder = null

Static Private Optional acquireSessionPromise

acquireSessionPromise?: Promise<string>

Static Private sessionAcquired

sessionAcquired: boolean = false

Accessors

connection

  • get connection(): null | Promise<T>

  • Returns a promise that resolves to a client that can be used to send messages to the embedded content.

    Returns null | Promise<T>

isConnected

  • get isConnected(): boolean

  • Indicates whether two way communication has successfully been established with the embedded content.

    Returns boolean

targetOrigin

  • get targetOrigin(): string

Methods

Private acquireCookielessEmbedSession

  • acquireCookielessEmbedSession(): Promise<string>

Private acquireCookielessEmbedSessionInternal

  • acquireCookielessEmbedSessionInternal(): Promise<string>

Private acquireSession

Private addIframeMonitor

  • addIframeMonitor(iframe: HTMLIFrameElement): void

connect

  • connect(): Promise<T>

  • Establish two way communication with embedded content. Returns a promise that resolves to a client that can be used to send messages to the embedded content.

    Returns Promise<T>

Private createIframe

  • createIframe(url: string): Promise<T>

Private createUrl

  • createUrl(): Promise<string>

Private generateTokens

Private getResource

  • getResource(resource: string | CookielessRequestInit): { init: undefined | { body?: null | BodyInit; cache?: RequestCache; credentials?: RequestCredentials; headers?: HeadersInit; integrity?: string; keepalive?: boolean; method?: string; mode?: RequestMode; redirect?: RequestRedirect; referrer?: string; referrerPolicy?: ReferrerPolicy; signal?: null | AbortSignal; window?: null }; url: string }

  • Parameters

    Returns { init: undefined | { body?: null | BodyInit; cache?: RequestCache; credentials?: RequestCredentials; headers?: HeadersInit; integrity?: string; keepalive?: boolean; method?: string; mode?: RequestMode; redirect?: RequestRedirect; referrer?: string; referrerPolicy?: ReferrerPolicy; signal?: null | AbortSignal; window?: null }; url: string }

    • init: undefined | { body?: null | BodyInit; cache?: RequestCache; credentials?: RequestCredentials; headers?: HeadersInit; integrity?: string; keepalive?: boolean; method?: string; mode?: RequestMode; redirect?: RequestRedirect; referrer?: string; referrerPolicy?: ReferrerPolicy; signal?: null | AbortSignal; window?: null }
    • url: string

Private sendScrollData

  • sendScrollData(iframe: HTMLIFrameElement): void

Generated using TypeDoc