AdsApp.​DraftIterator

  • A DraftIterator is used to iterate through a collection of drafts.

  • The hasNext() method checks if there are more drafts to iterate over.

  • The next() method returns the next draft in the sequence.

  • The totalNumEntities() method provides the total count of drafts initially matched, although the actual number available via iteration might be lower due to limits.

 An iterator of drafts.

Typical usage: 

while (draftIterator.hasNext()) {
  var draft = draftIterator.next();
}
 Related:

Methods:

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

Return values:

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