Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScreenMeet

This is a browser-only class. Creates a ScreenMeet object which can be used to render session information to an UI. Will automatically intantiate a Global instance when constructed. Emits the following events:

Events
Event Params Description
authenticated Global.me emitted when a user is authenticated
updated ScreenMeet.trackedSessions emitted when the tracked session list is updated
sessionstatechanged SupportSession emitted if {@link ScreenMeetOptions.trackSessionState} is enabled and the session state changes
signout emitted when a user signs out
destroyed emitted when the object id destroyed via ScreenMeet.destroy

Hierarchy

  • EventEmitter
    • ScreenMeet

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns ScreenMeet

Properties

api

api: ScreenMeetAPI

destroyed

destroyed: boolean = false

global

global: Global

instance_id

instance_id: string = ...

options

options: ScreenMeetOptions

Optional trackedSessionIdList

trackedSessionIdList: string[] = []

Optional trackedSessions

trackedSessions: {} = {}

Type declaration

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): ScreenMeet

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

closeSession

  • closeSession(id: string): Promise<void>

  • Closes / ends the session with a given ID.

    Parameters

    • id: string

    Returns Promise<void>

createAdhocSession

  • Creates a session that is not associated with any external object.

    Parameters

    • type: ScreenMeetSessionType
    • label: string
    • prefs: AgentPrefOptions = {}
    • Optional userDescription: string

      The alias to use for the creator of the session. If not used, the user name will be used.

    Returns Promise<SupportSession>

createRelatedSession

  • Creates a session that is not associated with any external object.

    Parameters

    • type: ScreenMeetSessionType
    • label: string
    • prefs: AgentPrefOptions = {}
    • parentObject: ParentObject

      A ParentObject describing the related object. This is used to perform data synchronization.

    • externalMapping: string

      This should be a globally unique string identifying the parent object. eg: myservicename.myinstance.myobject.id (spiffycrm.acmebrand.case.g4j231j8f).

    • Optional userDescription: string

      The alias to use for the creator of the session. If not used, the user name will be used.

    Returns Promise<SupportSession>

destroy

  • destroy(): void

  • Removes all intervals and event handlers

    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)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getSessionPrefOptions

getUrls

  • Returns various URL endpoints for a session. Results will vary depending on the session type.

    Parameters

    Returns ScreenMeetUrls

isAuthenticated

  • isAuthenticated(): boolean

  • Syntactic sugar accessor method

    Returns boolean

listRelatedObjectSessions

  • listRelatedObjectSessions(externalObjectMappingKey: string): Promise<SupportSession[]>

  • Returns a promise that resolves with an array of sessions associated with the related object mapping key

    Parameters

    • externalObjectMappingKey: string

    Returns Promise<SupportSession[]>

listUserSessions

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

onAuthenticated

  • Emits authenticated event at the instance level

    Parameters

    Returns void

Private onDiscovery

  • onDiscovery(sessionId: string, stateActive: boolean): Promise<void>

  • Triggered when discovery polling detects a change in the session state

    Parameters

    • sessionId: string
    • stateActive: boolean

    Returns Promise<void>

onSignout

  • onSignout(): void

  • Emits a signout event at the instance level

    Returns void

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns ScreenMeet

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ScreenMeet

setMaxListeners

  • Parameters

    • n: number

    Returns ScreenMeet

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

  • Peforms a global signout

    Returns void

Private updateTrackedSessionList

  • Parameters

    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