Paginator API- iOS

The Paginator class provides methods for iterating through a record set returned by a call to the ServiceNow Table API through the NowTableService. It is the object that is returned by the NowTableService paginator() methods. Do not call this method outside of that environment.

Parent Topic:Mobile SDK - iOS

Paginator - first() throws

Fetches the first page of the return results.

If this method can't fetch the first page, it throws a PaginationError.

The following code example shows how to call this method.

class PaginatorTestViewModel<T: JSONRepresentable>: ObservableObject {
  @Published var result: Result<String, Error>?
  private let paginator: Paginator<T>
  private var subscriptions = Set<AnyCancellable>()

  init(paginator: Paginator<T>) {
    self.paginator = paginator
    subscribeToPaginator()
  }

  private func subscribeToPaginator() {
    paginator.publisher
      .receive(on: DispatchQueue.main)
      .sink { [weak self] comp in
        if case .failure(let error) = comp {
          self?.result = .failure(error)
        }
      } receiveValue: { [weak self] jsonRepresentable in
        self?.result = .success(jsonRepresentable.jsonDescription)
      }
      .store(in: &subscriptions)
  }

  func first() {
    result = nil
    do {
      try paginator.first()
    } catch {
      self.result = .failure(error)
    }
  }
}

Paginator - last() throws

Fetches the last page of the return results.

If this method can't fetch the last page, it throws a PaginationError.

The following code example shows how to call this method.

…
func last() {
  result = nil
  do {
    try paginator.last()
  } catch {
    self.result = .failure(error)
  }
}
…

Paginator - next() throws

Fetches the next page of the return results.

If there are no more pages to fetch, the method throws a PaginationError.

The following code example shows how to call this method.

…
func next() {
  result = nil
  do {
    try paginator.next()
  } catch {
    self.result = .failure(error)
  }
}
…

Paginator - previous() throws

Fetches the previous page of the return results.

If the method can't fetch the previous page, it throws a PaginationError.

The following code example shows how to call this method.

…
func previous() {
  result = nil
  do {
    try paginator.previous()
  } catch {
    self.result = .failure(error)
  }
}
…

Paginator - reset()

Resets the Paginator back to the first page but doesn't return the first page of the return results.

The following code example shows how to call this method.

…
func reset() {
  result = nil
  paginator.reset()
}
…