AdsApp.​UserListIterator

  • UserListIterator is an iterator for user lists.

  • It includes methods like hasNext() to check for more elements, next() to get the next user list, and totalNumEntities() to see the total number of matched entities.

  • The totalNumEntities() method provides the count before considering any limits on entity reads.

 An iterator of user lists.

Typical usage: 

while (userListIterator.hasNext()) {
  var userList = userListIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.UserList Returns the next UserList 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 UserList in the iterator.

Return values:

TypeDescription
AdsApp.UserList The next UserList 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.