Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeleteKeyPoller

Package version

Class that deletes a poller that waits until a key finishes being deleted

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

intervalInMs

intervalInMs: number

Defines how much time the poller is going to wait before making a new request to the service.

memberof

DeleteKeyPoller

Protected operation

operation: PollOperation<DeleteKeyPollOperationState, DeletedKey>

Methods

cancelOperation

  • cancelOperation(options?: undefined | object): Promise<void>

  • Parameters

    • Optional options: undefined | object

    Returns Promise<void>

delay

  • delay(): Promise<void>

  • The method used by the poller to wait before attempting to update its operation.

    memberof

    DeleteKeyPoller

    Returns Promise<void>

getOperationState

  • getOperationState(): PollOperationState<DeletedKey>

  • Returns PollOperationState<DeletedKey>

getResult

  • Returns DeletedKey | undefined

isDone

  • isDone(): boolean

  • Returns boolean

isStopped

  • isStopped(): boolean

  • Returns boolean

onProgress

  • onProgress(callback: function): CancelOnProgress

poll

  • poll(options?: undefined | object): Promise<void>

  • Parameters

    • Optional options: undefined | object

    Returns Promise<void>

pollUntilDone

  • Returns Promise<DeletedKey>

stopPolling

  • stopPolling(): void

  • Returns void

toString

  • toString(): string

  • Returns string

Generated using TypeDoc