Class ReleasePhoneNumbersPollOperation

Package version

The poll operation for releasing a phone number or list of phone numbers.

Hierarchy

PhoneNumberPollOperationBase<ReleasePhoneNumbersPollOperationState, PhoneNumberRelease>
- ReleasePhoneNumbersPollOperation

Implements

any

Index

Constructors

constructor

Properties

state

Methods

Constructors

constructor

new ReleasePhoneNumbersPollOperation(state: ReleasePhoneNumbersPollOperationState, client: PhoneNumberAdministration, requestOptions: OperationOptions): ReleasePhoneNumbersPollOperation

Overrides PhoneNumberPollOperationBase.constructor
- Defined in phoneNumber/lro/release/operation.ts:26
Initializes an instance of PurchaseReservationPollOperation

Parameters
- state: ReleasePhoneNumbersPollOperationState
  
  The state of the poll operation
- client: PhoneNumberAdministration
  
  A reference to the generated client used to make requests internally.
- requestOptions: OperationOptions
  
  Additional options for the underlying requests.
Returns ReleasePhoneNumbersPollOperation

Properties

state

state: ReleasePhoneNumbersPollOperationState

The state of the poll operation

Methods

cancel

cancel(): Promise<PollOperation<ReleasePhoneNumbersPollOperationState, PhoneNumberRelease>>

Inherited from PhoneNumberPollOperationBase.cancel
- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:54
Reaches to the service and cancels the Poller operation and the underlying request.

Returns Promise<PollOperation<ReleasePhoneNumbersPollOperationState, PhoneNumberRelease>>

toString

toString(): string

Inherited from PhoneNumberPollOperationBase.toString
- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:61
summary

Serializes the Poller operation.

Returns string

update

update(options?: UpdatePollerOptions<ReleasePhoneNumbersPollOperationState>): Promise<ReleasePhoneNumbersPollOperation>

Overrides PhoneNumberPollOperationBase.update
- Defined in phoneNumber/lro/release/operation.ts:109
Reaches to the service and queries the status of the operation.

Parameters
- Default value options: UpdatePollerOptions<ReleasePhoneNumbersPollOperationState> = {}
Returns Promise<ReleasePhoneNumbersPollOperation>

Generated using TypeDoc