Class OfflineBatchHandler

Implements

IOfflineBatchHandler

Index

Constructors

Methods

cleanStorage hasStoredBatch initialize sendNextBatch storeBatch teardown

Constructors

constructor

new OfflineBatchHandler(logger?, unloadHookContainer?): OfflineBatchHandler
Parameters
- Optionallogger: IDiagnosticLogger
- OptionalunloadHookContainer: IUnloadHookContainer
Returns OfflineBatchHandler
- Defined in OfflineBatchHandler.ts:22

Methods

cleanStorage

cleanStorage(cb?): IOfflineBatchCleanResponse | IPromise<IOfflineBatchCleanResponse>
Parameters
- Optionalcb: ((res: IOfflineBatchCleanResponse) => void)
  - - (res): void
    - Parameters
      res: IOfflineBatchCleanResponse
      Returns void
Returns IOfflineBatchCleanResponse | IPromise<IOfflineBatchCleanResponse>
Implementation of IOfflineBatchHandler.cleanStorage
- Defined in OfflineBatchHandler.ts:426

hasStoredBatch

hasStoredBatch(callback?): boolean | IPromise<boolean>
Parameters
- Optionalcallback: ((hasBatches: boolean) => void)
  - - (hasBatches): void
    - Parameters
      hasBatches: boolean
      Returns void
Returns boolean | IPromise<boolean>
Implementation of IOfflineBatchHandler.hasStoredBatch
- Defined in OfflineBatchHandler.ts:421

initialize

initialize(providerContext): any
Initializes the provider using the config
Parameters
- providerContext: ILocalStorageProviderContext
Returns any
True if the provider is initialized and available for use otherwise false
- Defined in OfflineBatchHandler.ts:405

sendNextBatch

sendNextBatch(cb?, sync?, xhrOverride?, cnt?): IOfflineBatchResponse | IPromise<IOfflineBatchResponse>
Parameters
- Optionalcb: OfflineBatchCallback
- Optionalsync: boolean
- OptionalxhrOverride: IXHROverride
- Optionalcnt: number
Returns IOfflineBatchResponse | IPromise<IOfflineBatchResponse>
Implementation of IOfflineBatchHandler.sendNextBatch
- Defined in OfflineBatchHandler.ts:416

storeBatch

storeBatch(batch, cb?, sync?): IOfflineBatchStoreResponse | IPromise<IOfflineBatchStoreResponse>
Parameters
- batch: IPayloadData
- Optionalcb: OfflineBatchStoreCallback
- Optionalsync: boolean
Returns IOfflineBatchStoreResponse | IPromise<IOfflineBatchStoreResponse>
Implementation of IOfflineBatchHandler.storeBatch
- Defined in OfflineBatchHandler.ts:411

teardown

teardown(unloadCtx?, unloadState?): any
Parameters
- OptionalunloadCtx: IProcessTelemetryUnloadContext
- OptionalunloadState: ITelemetryUnloadState
Returns any
Implementation of IOfflineBatchHandler.teardown
- Defined in OfflineBatchHandler.ts:431