Options
All
  • Public
  • Public/Protected
  • All
Menu
label

EVENTS

description

An event class that is attached to emitted events as a payload for events with the name auth.open.

This class can also be used to implement the event emitter.

Parameters:

Name Type Description
challenge string The authentication challenge.
since

v0.6.0

Hierarchy

  • OnAuthOpened

Index

Constructors

Properties

Methods

Constructors

Properties

challenge: string

Contains the authentication challenge which consists in a unique identifier that relates to the operation of authenticating the user.

access

public

var

{string}

Methods

  • Static helper method that creates an instance of this event class.

    This method can/shall be used whenever an event is emitted by the runtime, or whenever an event is being listened to.

    access

    public

    static

    Parameters

    • challenge: string

      The unique authentication challenge.

    Returns OnAuthOpened

    The prepared event (which can be emitted).

Generated using TypeDoc