Paginator API - iOS

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：5分

    • Paginator クラスは、NowTableService を介して ServiceNow Table API を呼び出すことによって返されたレコード セットを反復処理するためのメソッドを提供します。これは、NowTableService paginator() メソッドによって返されるオブジェクトです。その環境の外部でこのメソッドを呼び出さないでください。

    表 : 1. プロパティ
    名前 タイプ 説明
    hasNext ブール フェッチする次のページがあるかどうかを示すフラグ。
    有効な値：
    • true:次のページが利用可能です。
    • false:次のページは使用できません。
    前へ ブール フェッチする前のページがあるかどうかを示すフラグ。
    有効な値：
    • true:前のページが利用可能です。
    • false:前のページは使用できません。
    ビジー状態 ブール Paginator オブジェクトがデータのフェッチでビジーかどうかを示すフラグ。
    有効な値：
    • true:パブリッシャーはビジー状態です。
    • false:パブリッシャーはビジー状態ではありません。
    isFinished ブール Paginator オブジェクトが完了したかどうかを示すフラグ。ページネーションが終了するように設定されている場合、最後のページがフェッチされた時点で、ページネーションオブジェクトのパブリッシャーは終了します。Paginator オブジェクトは、終了後はページをフェッチできません。詳細については、 publisherShouldFinish パラメーターの説明を参照してください。
    有効な値：
    • true:パブリッシャーは完了しました。
    • false:パブリッシャーは完成していません。
    itemsPerPage 整数 ページごとにフェッチするアイテムの数。

    デフォルト値：20
    ページ数 整数 レコードセット内の合計ページ数。

    Paginator オブジェクトがまだページをフェッチしていない場合、このパラメーターは Int.max に設定されます。ServiceNowインスタンスに対して最初の要求が行われた後、ページ数はServiceNowインスタンスから受信した実際のページ数に更新されます。
    ページ 整数 ページネーションされたレコードセット内の現在のページ。
    publisher 文字列 ページネーションされたデータのストリームをサブスクライバーに提供するパブリッシャー。
    注:
    デフォルトでは、パブリッシャーは終了しません。この動作を変更するには、 publisherShouldFinish プロパティを true に設定します。
    publisherShouldFinish ブール 最後のページがフェッチされたときに Paginator オブジェクトのパブリッシャーを停止するかどうかを示すフラグ。Paginator オブジェクトは、終了後はページをフェッチできません。
    有効な値：
    • true:最後のページがフェッチされると、パブリッシャーは追加データの提供から解放されます。reset() メソッドは機能しなくなりました。
    • false:パブリッシャーは完了せず、ナビゲーションに関係なくすべてのメソッドが完全に機能します。

    デフォルト値：false

    Paginator - first() がスロー

    返される結果の最初のページをフェッチします。

    このメソッドが最初のページをフェッチできない場合は、 PaginationError をスローします。

    表 : 2. パラメーター
    名前 タイプ 説明
    なし
    表 : 3. 返される内容
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

    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() がスロー

    戻り値の最後のページをフェッチします。

    このメソッドが最後のページをフェッチできない場合は、 PaginationError をスローします。

    表 : 4. パラメーター
    名前 タイプ 説明
    なし
    表 : 5. 返される内容
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

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

    Paginator - next() がスロー

    返される結果の次のページをフェッチします。

    フェッチするページがこれ以上ない場合、メソッドは PaginationError をスローします。

    表 : 6. パラメーター
    名前 タイプ 説明
    なし
    表 : 7. 返される内容
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

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

    Paginator - previous() がスロー

    戻り値の前のページをフェッチします。

    メソッドが前のページをフェッチできない場合は、 PaginationError をスローします。

    表 : 8. パラメーター
    名前 タイプ 説明
    なし
    表 : 9. 返される内容
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

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

    Paginator:reset()

    Paginator を最初のページにリセットしますが、返される結果の最初のページは返しません。

    表 : 10. パラメーター
    名前 タイプ 説明
    なし
    表 : 11. 返される内容
    タイプ 説明
    なし

    次のコード例は、このメソッドを呼び出す方法を示しています。

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