Type alias PerformanceEvent

PerformanceEvent: {
    accessTokenSize?: number;
    allowNativeBroker?: boolean;
    appName?: string;
    appVersion?: string;
    authority: string;
    cacheLookupPolicy?: number;
    clientId: string;
    correlationId: string;
    durationMs?: number;
    endPageVisibility?: string | null;
    errorCode?: string;
    eventId: string;
    extensionHandshakeTimedOut?: boolean;
    extensionHandshakeTimeoutMs?: number;
    extensionId?: string;
    extensionInstalled?: boolean;
    extensionVersion?: string;
    fromCache?: boolean | null;
    httpVerToken?: string;
    idTokenSize?: number;
    incompleteSubMeasurements?: Map<string, SubMeasurement>;
    incompleteSubsCount?: number;
    isNativeBroker?: boolean;
    libraryName: string;
    libraryVersion: string;
    matsAccountJoinOnEnd?: string;
    matsAccountJoinOnStart?: string;
    matsApiErrorCode?: number;
    matsBrokerVersion?: string;
    matsDeviceJoin?: string;
    matsHttpEventCount?: number;
    matsHttpStatus?: number;
    matsPromptBehavior?: string;
    matsSilentBiSubCode?: number;
    matsSilentCode?: number;
    matsSilentMessage?: string;
    matsSilentStatus?: number;
    matsUiVisible?: boolean;
    name: string;
    queuedCount?: number;
    queuedManuallyCompletedCount?: number;
    queuedTimeMs?: number;
    refreshTokenSize?: number;
    requestId?: string;
    startPageVisibility?: string | null;
    startTimeMs: number;
    status: PerformanceEventStatus;
    subErrorCode?: string;
    success?: boolean | null;
    visibilityChangeCount?: number;
}

Performance measurement taken by the library, including metadata about the request and application.

Type declaration

  • Optional accessTokenSize?: number

    Size of the access token

  • Optional allowNativeBroker?: boolean

    Native broker fields

  • Optional appName?: string

    Application name as specified by the app.

  • Optional appVersion?: string

    Application version as specified by the app.

  • authority: string

    Login authority used for the request

  • Optional cacheLookupPolicy?: number

    Cache lookup policy

  • clientId: string

    Client id for the application

  • correlationId: string

    Correlation ID used for the request

  • Optional durationMs?: number

    End-to-end duration in milliseconds.

    Date

    3/22/2022 - 3:40:05 PM

  • Optional endPageVisibility?: string | null

    Visibility of the page when the event completed. Read from: https://developer.mozilla.org/docs/Web/API/Page_Visibility_API

  • Optional errorCode?: string

    Add specific error code in case of failure

  • eventId: string

    Unique id for the event

  • Optional extensionHandshakeTimedOut?: boolean
  • Optional extensionHandshakeTimeoutMs?: number
  • Optional extensionId?: string

    The following are fields that may be emitted in native broker scenarios

  • Optional extensionInstalled?: boolean
  • Optional extensionVersion?: string
  • Optional fromCache?: boolean | null

    Whether the result was retrieved from the cache.

  • Optional httpVerToken?: string
  • Optional idTokenSize?: number

    Size of the id token

  • Optional incompleteSubMeasurements?: Map<string, SubMeasurement>

    Sub-measurements for internal use. To be deleted before flushing.

  • Optional incompleteSubsCount?: number
  • Optional isNativeBroker?: boolean

    Whether the response is from a native component (e.g., WAM)

  • libraryName: string

    Name of the library used for the operation.

  • libraryVersion: string

    Version of the library used for the operation.

  • Optional matsAccountJoinOnEnd?: string
  • Optional matsAccountJoinOnStart?: string
  • Optional matsApiErrorCode?: number
  • Optional matsBrokerVersion?: string
  • Optional matsDeviceJoin?: string
  • Optional matsHttpEventCount?: number
  • Optional matsHttpStatus?: number
  • Optional matsPromptBehavior?: string
  • Optional matsSilentBiSubCode?: number
  • Optional matsSilentCode?: number
  • Optional matsSilentMessage?: string
  • Optional matsSilentStatus?: number
  • Optional matsUiVisible?: boolean
  • name: string

    Event name (usually in the form of classNameFunctionName)

  • Optional queuedCount?: number

    Amount of times queued in the JS event queue.

  • Optional queuedManuallyCompletedCount?: number

    Amount of manually completed queue events.

  • Optional queuedTimeMs?: number

    Amount of time spent in the JS queue in milliseconds.

  • Optional refreshTokenSize?: number

    Size of the refresh token

  • Optional requestId?: string

    Request ID returned from the response

  • Optional startPageVisibility?: string | null

    Visibility of the page when the event completed. Read from: https://developer.mozilla.org/docs/Web/API/Page_Visibility_API

  • startTimeMs: number

    Unix millisecond timestamp when the event was initiated.

  • status: PerformanceEventStatus

    State of the perforance measure.

  • Optional subErrorCode?: string

    Add specific sub error code in case of failure

  • Optional success?: boolean | null

    Whether or the operation completed successfully.

  • Optional visibilityChangeCount?: number

Export

Settings

Member Visibility

Theme

Generated using TypeDoc