Class: Session

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

• type: string

• callback: null | EventListenerOrEventListenerObject

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

EventEmitter.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8256

dispatchEvent()

dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

emit(type, ...args): void

off(type, listener): void

on(type, listener): void

once(type, listener): void

removeEventListener(type, callback, options?): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

• type: string

• callback: null | EventListenerOrEventListenerObject

• options?: boolean | EventListenerOptions

signIn(credentials?): Promise<void>

signOut(): Promise<undefined | Response>

Signs out of the current account and revokes the credentials.

static create(options): Promise<Session>

static fromCache(cache, session_args): Promise<null | SessionData>

Retrieves session data from cache.

Parameters

• cache: ICache

A valid cache implementation.

• session_args: SessionArgs

User provided session arguments.

static getSessionData(lang, location, account_index, visitor_data, enable_safety_mode, generate_session_locally, device_category, client_name, tz, fetch, on_behalf_of_user?, cache?, enable_session_cache?, po_token?): Promise<object>