AdsApp.​PhoneNumberIterator

  • A PhoneNumberIterator is used to iterate through phone numbers.

  • It provides methods to check if there are more elements (hasNext()) and retrieve the next element (next()).

  • The totalNumEntities() method returns the total number of entities matched by the selector, independent of limits.

 An iterator of phone numbers.

Typical usage: 

while (phoneNumberIterator.hasNext()) {
  var phoneNumber = phoneNumberIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.PhoneNumber Returns the next PhoneNumber in the iterator.
totalNumEntities() int Returns the total number of entities matched by the selector which generated this iterator.

hasNext()

Returns true if the iterator has more elements.

Return values:

TypeDescription
boolean true if the iterator has more elements.

next()

Returns the next PhoneNumber in the iterator.

Return values:

TypeDescription
AdsApp.PhoneNumber The next PhoneNumber in the iterator.

totalNumEntities()

Returns the total number of entities matched by the selector which generated this iterator.

Note that the returned number disregards limits, and that the iterator is not guaranteed to have this many elements — hasNext will start to return false and next will start to throw exceptions as soon as the limit for entity reads has been reached, even if the selector matched more entities.

Return values:

TypeDescription
int The number of entities matched by the selector which generated this iterator.