PhoneNumberSearchResult Class

  • Reference
Package:
com.azure.communication.phonenumbers.models
Maven Artifact:
com.azure:azure-communication-phonenumbers:1.1.12
  • java.lang.Object
    • com.azure.communication.phonenumbers.models.PhoneNumberSearchResult

public final class PhoneNumberSearchResult

The PhoneNumberSearchResult model.

Constructor Summary

Constructor Description
PhoneNumberSearchResult()

Method Summary

Modifier and Type Method and Description
PhoneNumberAssignmentType getAssignmentType()

Get the assignmentType property: Phone number's assignment type.
PhoneNumberCapabilities getCapabilities()

Get the capabilities property: Capabilities of a phone number.
PhoneNumberCost getCost()

Get the cost property: The incurred cost for a single phone number.
PhoneNumberType getPhoneNumberType()

Get the phoneNumberType property: The phone number's type, e.g.
List<String> getPhoneNumbers()

Get the phoneNumbers property: The phone numbers that are available.
OffsetDateTime getSearchExpiresBy()

Get the searchExpiresBy property: The date that this search result expires and phone numbers are no longer on hold.
String getSearchId()

Get the searchId property: The search id.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PhoneNumberSearchResult

public PhoneNumberSearchResult()

Method Details

getAssignmentType

public PhoneNumberAssignmentType getAssignmentType()

Get the assignmentType property: Phone number's assignment type.

Returns:

the assignmentType value.

getCapabilities

public PhoneNumberCapabilities getCapabilities()

Get the capabilities property: Capabilities of a phone number.

Returns:

the capabilities value.

getCost

public PhoneNumberCost getCost()

Get the cost property: The incurred cost for a single phone number.

Returns:

the cost value.

getPhoneNumberType

public PhoneNumberType getPhoneNumberType()

Get the phoneNumberType property: The phone number's type, e.g. geographic, or tollFree.

Returns:

the phoneNumberType value.

getPhoneNumbers

public List getPhoneNumbers()

Get the phoneNumbers property: The phone numbers that are available. Can be fewer than the desired search quantity.

Returns:

the phoneNumbers value.

getSearchExpiresBy

public OffsetDateTime getSearchExpiresBy()

Get the searchExpiresBy property: The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z.

Returns:

the searchExpiresBy value.

getSearchId

public String getSearchId()

Get the searchId property: The search id.

Returns:

the searchId value.

Applies to