Package com.azure.communication.phonenumbers

Class PhoneNumbersAsyncClient

java.lang.Object

com.azure.communication.phonenumbers.PhoneNumbersAsyncClient

public final class PhoneNumbersAsyncClient
extends Object

Asynchronous client for Communication service phone number operations.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PurchasePhoneNumbersResult>	beginPurchasePhoneNumbers(String searchId)	Starts the purchase of the phone number(s) in the search result associated with a given id.
com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,ReleasePhoneNumberResult>	beginReleasePhoneNumber(String phoneNumber)	Begins release of a purchased phone number.
com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PhoneNumberSearchResult>	beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities)	Starts the search for available phone numbers to purchase.
com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PhoneNumberSearchResult>	beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities, PhoneNumberSearchOptions searchOptions)	Starts the search for available phone numbers to purchase.
com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PurchasedPhoneNumber>	beginUpdatePhoneNumberCapabilities(String phoneNumber, PhoneNumberCapabilities capabilities)	Update capabilities of a purchased phone number.
Mono<PurchasedPhoneNumber>	getPurchasedPhoneNumber(String phoneNumber)	Gets information about a purchased phone number.
Mono<com.azure.core.http.rest.Response<PurchasedPhoneNumber>>	getPurchasedPhoneNumberWithResponse(String phoneNumber)	Gets information about a purchased phone number with response.
com.azure.core.http.rest.PagedFlux<PurchasedPhoneNumber>	listPurchasedPhoneNumbers()	Gets the list of the purchased phone numbers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPurchasedPhoneNumber

public Mono<PurchasedPhoneNumber> getPurchasedPhoneNumber(String phoneNumber)

Gets information about a purchased phone number.

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

Returns:

PurchasedPhoneNumber representing the purchased telephone number.

Throws:

NullPointerException - if phoneNumber is null.

getPurchasedPhoneNumberWithResponse

public Mono<com.azure.core.http.rest.Response<PurchasedPhoneNumber>> getPurchasedPhoneNumberWithResponse(String phoneNumber)

Gets information about a purchased phone number with response.

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

Returns:

PurchasedPhoneNumber representing the purchased telephone number.

Throws:

NullPointerException - if phoneNumber is null.

listPurchasedPhoneNumbers

public com.azure.core.http.rest.PagedFlux<PurchasedPhoneNumber> listPurchasedPhoneNumbers()

Gets the list of the purchased phone numbers.

Returns:

A PagedFlux of PurchasedPhoneNumber instances representing a purchased telephone numbers.

beginSearchAvailablePhoneNumbers

public com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PhoneNumberSearchResult> beginSearchAvailablePhoneNumbers(String countryCode,
                                                                                                                                   PhoneNumberType phoneNumberType,
                                                                                                                                   PhoneNumberAssignmentType assignmentType,
                                                                                                                                   PhoneNumberCapabilities capabilities)

Starts the search for available phone numbers to purchase.

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType The phone number type.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

capabilities - PhoneNumberCapabilities The phone number capabilities.

Returns:

A PollerFlux object with the reservation result.

Throws:

NullPointerException - if countryCode or searchRequest is null.

beginSearchAvailablePhoneNumbers

public com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PhoneNumberSearchResult> beginSearchAvailablePhoneNumbers(String countryCode,
                                                                                                                                   PhoneNumberType phoneNumberType,
                                                                                                                                   PhoneNumberAssignmentType assignmentType,
                                                                                                                                   PhoneNumberCapabilities capabilities,
                                                                                                                                   PhoneNumberSearchOptions searchOptions)

Starts the search for available phone numbers to purchase.

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType The phone number type.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

capabilities - PhoneNumberCapabilities The phone number capabilities.

searchOptions - The phone number search options.

Returns:

A PollerFlux object with the reservation result.

Throws:

NullPointerException - if countryCode or searchRequest is null.

RuntimeException - if search operation fails.

beginPurchasePhoneNumbers

public com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PurchasePhoneNumbersResult> beginPurchasePhoneNumbers(String searchId)

Starts the purchase of the phone number(s) in the search result associated with a given id.

Parameters:

searchId - ID of the search.

Returns:

A PollerFlux object.

Throws:

NullPointerException - if searchId is null.

RuntimeException - if purchase operation fails.

beginReleasePhoneNumber

public com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,ReleasePhoneNumberResult> beginReleasePhoneNumber(String phoneNumber)

Begins release of a purchased phone number. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

Returns:

A PollerFlux object.

Throws:

NullPointerException - if phoneNumber is null.

RuntimeException - if release operation fails.

beginUpdatePhoneNumberCapabilities

public com.azure.core.util.polling.PollerFlux<PhoneNumberOperation,PurchasedPhoneNumber> beginUpdatePhoneNumberCapabilities(String phoneNumber,
                                                                                                                                  PhoneNumberCapabilities capabilities)

Update capabilities of a purchased phone number.

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

capabilities - Update capabilities of a purchased phone number.

Returns:

A PollerFlux object.

Throws:

NullPointerException - if phoneNumber or capabilities is null.

RuntimeException - if update capabilities operation fails.