Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Global

This is a window-global front-end only class for ScreenMeet. It manages authentication as well as session state polling.

Hierarchy

  • EventEmitter
    • Global

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Global(options: any): Global

  • Parameters

    • options: any

    Returns Global

Properties

api

api: ScreenMeetAPI

Optional cbdeployments

cbdeployments: CobrowseDeployment[]

Optional configsLoadedPromise

configsLoadedPromise: Promise<any>

Private discoveryInterval

discoveryInterval: any = null

Private discoveryIntervalMs

discoveryIntervalMs: number = 15000

Optional endpoints

endpoints: EndpointConfig

instances

instances: {} = {}

Type declaration

isAuthenticated

isAuthenticated: boolean = false

Private lastDiscoveryState

lastDiscoveryState: DiscoveryResponse = {}

Private Optional loginFail

loginFail: (er: Error) => void

Type declaration

    • (er: Error): void

    • Parameters

      • er: Error

      Returns void

Private Optional loginPromise

loginPromise: Promise<any>

Private loginWindow

loginWindow: any

Optional me

me: MeResponse

options

options: ScreenMeetOptions

Private Optional sessionExpiresAfter

sessionExpiresAfter: Date

Private Optional userDataKey

userDataKey: string = 'screenmeetuser'

Private windowWatcher

windowWatcher: any

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

Private clearUserData

  • clearUserData(): void

  • Removes any stored user session data from this object

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

Private getAuthUrl

  • getAuthUrl(provider: string, cburl: string, instance: string): string

  • Returns the authentication end-point URL to sign in with the front end.

    Parameters

    • provider: string
    • cburl: string

      the callback URL file which will receive auth data. Must be an authorized URL.

    • instance: string

    Returns string

Private getIntentToken

  • getIntentToken(randomBytesLength?: number): string

  • Creates an intent token which must match the response. CSRF security measure.

    Parameters

    • randomBytesLength: number = 32

    Returns string

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

loadCobrowseDeployments

  • loadCobrowseDeployments(): Promise<void>

  • Returns Promise<void>

loadEndpointConfig

  • loadEndpointConfig(): Promise<void>

  • Ensures the latest endpoint configurations are loaded. These are used to construct various URL's for different session types

    Returns Promise<void>

off

  • off(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

on

  • on(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

Private onAuthenticated

  • onAuthenticated(): Promise<void>

  • Runs after a user is successfully authenticated

    Returns Promise<void>

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

pollSessionDiscovery

  • pollSessionDiscovery(): Promise<void>

  • Returns Promise<void>

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

registerForPolling

  • Tracks the widget instance from the global - used for polling and other kind of global ops possibly.

    Parameters

    Returns void

Private rememberMe

  • rememberMe(): void

  • Stores information about the authenticated user in a localStorage var

    Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): Global

  • Parameters

    • Optional event: string | symbol

    Returns Global

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Global

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Global

Private restoreMe

  • restoreMe(): void

  • Restores a user session details from local storage

    Returns void

setMaxListeners

  • setMaxListeners(n: number): Global

  • Parameters

    • n: number

    Returns Global

signin

  • signin(provider: string, cburl: string, instance: string): Promise<MeResponse>

  • Opens an authentication dialog with the desired provider / instance. Returns a promise with a {@link MeResponse} after a successful authentication. Will reject if the auth window is closed or if there is an error.

    Parameters

    • provider: string
    • cburl: string
    • instance: string

    Returns Promise<MeResponse>

signout

  • signout(): void

  • Signs the user out

    Returns void

unregisterFromPolling

  • unregisterFromPolling(instance: ScreenMeet): void

  • Parameters

    Returns void

Private updateSessionExpireTime

  • updateSessionExpireTime(): void

  • Returns void

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc