Class PhoneNumberReservationPollOperationBase<TState, TResult>

Package version

Common properties and methods of the phone number reservation poller operations.

Type parameters

TState
TResult

Hierarchy

PhoneNumberReservationPollOperationBase
- ReservePhoneNumbersPollOperation
- PurchaseReservationPollOperation

Implements

any

Index

Constructors

constructor

Properties

state

Methods

Constructors

constructor

new PhoneNumberReservationPollOperationBase(state: TState, client: PhoneNumberAdministration, cancelMessage?: string): PhoneNumberReservationPollOperationBase

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:72
Initializes a new instance of the phone number reservation poll operation

Parameters
- state: TState
  
  The state of the poll operation
- client: PhoneNumberAdministration
  
  A reference to the generated client used to make requests internally.
- Default value cancelMessage: string = "Canceling not supported."
  
  A message to dispaly when a poll operation is cancelled.
Returns PhoneNumberReservationPollOperationBase

Properties

state

state: TState

The state of the poll operation

Methods

cancel

cancel(): Promise<PollOperation<TState, TResult>>

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:158
Reaches to the service and cancels the Poller operation and the underlying request.

Returns Promise<PollOperation<TState, TResult>>

cancelReservation

cancelReservation(reservationId: string, options?: CancelReservationOptions): Promise<VoidResponse>

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:123
Cancels the reservation associated with a given id.

Parameters
- reservationId: string
  
  The id of the reservation to cancel.
- Default value options: CancelReservationOptions = {}
  
  Additional request options.
Returns Promise<VoidResponse>

getReservation

getReservation(reservationId: string, options?: GetReservationOptions): Promise<GetReservationResponse>

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:92
Gets the reservation associated with a given id.

Parameters
- reservationId: string
  
  The id of the reservation to fetch.
- Default value options: GetReservationOptions = {}
  
  Additional request options.
Returns Promise<GetReservationResponse>

toString

toString(): string

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:165
summary

Serializes the Poller operation.

Returns string

update

update(): Promise<PollOperation<TState, TResult>>

- Defined in phoneNumber/lro/phoneNumberPollerBase.ts:151
Reaches to the service and updates the Poller operation.

Returns Promise<PollOperation<TState, TResult>>

Generated using TypeDoc