Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • InternalPingType

Implements

Index

Constructors

Properties

includeClientId: boolean
name: string
reasonCodes: string[]
rejectTestPromiseFunction?: PromiseCallback
resolveTestPromiseFunction?: PromiseCallback
sendIfEmpty: boolean
testCallback?: ValidatorFunction

Methods

  • internalSubmit(reason?: string, testResolver?: PromiseCallback): void
  • submit(reason?: string): void
  • submitUndispatched(reason?: string, testResolver?: PromiseCallback): Promise<void>
  • An implemention of submit that does not dispatch the submission task.

    Important

    This method should never be exposed to users.

    Parameters

    • Optional reason: string

      The reason the ping was triggered. Included in the ping_info.reason part of the payload.

    • Optional testResolver: PromiseCallback

      The asynchronous validation function to run in order to validate the ping content.

    Returns Promise<void>

  • testBeforeNextSubmit(callbackFn: ValidatorFunction): Promise<void>

Generated using TypeDoc