Class InternalPingType

The common set of data for creating a new ping.

Implements

default

Index

Constructors

Properties

includeClientId name preciseTimestamps? reasonCodes rejectTestPromiseFunction? resolveTestPromiseFunction? sendIfEmpty testCallback?

Methods

internalSubmit submit testBeforeNextSubmit

Constructors

constructor

new InternalPingType(meta): InternalPingType
Parameters
- meta: default
Returns InternalPingType
- Defined in src/core/pings/ping_type.ts:44

Properties

`Readonly` includeClientId

includeClientId: boolean

`Readonly` name

name: string

`Optional` `Readonly` preciseTimestamps

preciseTimestamps?: boolean

`Readonly` reasonCodes

reasonCodes: string[]

`Private` `Optional` rejectTestPromiseFunction

rejectTestPromiseFunction?: PromiseCallback

`Private` `Optional` resolveTestPromiseFunction

resolveTestPromiseFunction?: PromiseCallback

`Readonly` sendIfEmpty

sendIfEmpty: boolean

`Private` `Optional` testCallback

testCallback?: ValidatorFunction

Methods

`Private` internalSubmit

internalSubmit(reason?, testResolver?): void
Parameters
- Optional reason: string
- Optional testResolver: PromiseCallback
Returns void
- Defined in src/core/pings/ping_type.ts:82

submit

submit(reason?): void
Parameters
- Optional reason: string
Returns void
- Defined in src/core/pings/ping_type.ts:54

testBeforeNextSubmit

testBeforeNextSubmit(callbackFn): Promise<void>
Parameters
- callbackFn: ValidatorFunction
Returns Promise<void>
- Defined in src/core/pings/ping_type.ts:117

Generated using TypeDoc