---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API do Paginator - iOS

# API do Paginator - iOS {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

A classe Paginator fornece métodos para iterar por meio de um conjunto de registros retornado por uma chamada para a API de ServiceNow tabela por meio do NowTableService. É o objeto retornado pelos métodos NowTableService paginator(). Não chame este método fora desse ambiente.
{#PaginatorIOSAPI__table_vx2_klw_5pb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| hasNext | Booliano | Sinalizador que indica se há uma próxima página a ser buscada. Valores válidos: * verdadeiro: a próxima página está disponível. * falso: a próxima página não está disponível. |
| temAnterior | Booliano | Sinalizador que indica se há uma página anterior a ser buscada. Valores válidos: * verdadeiro: a página anterior está disponível. * falso: a página anterior não está disponível. |
| estáOcupado | Booliano | Sinalizador que indica se o objeto Paginator está ocupado buscando dados. Valores válidos: * verdadeiro: o fornecedor está ocupado. * falso: o fornecedor não está ocupado. |
| estáConcluído | Booliano | Sinalizador que indica se o objeto Paginator foi concluído. Quando o paginador está configurado para ser concluído, o fornecedor do objeto Paginator é concluído quando a última página é obtida. Um objeto Paginator não pode buscar páginas após a conclusão. Para obter informações adicionais, consulte a descrição do parâmetro publisherShouldFinish. Valores válidos: * verdadeiro: o fornecedor foi concluído. * falso: o fornecedor não foi concluído. |
| itensPorPágina | Inteiro | Número de itens a serem buscados por página. Padrão: 20 |
| númeroDePáginas | Inteiro | Número total de páginas no conjunto de registros. Quando o objeto Paginator ainda não tiver obtido nenhuma página, este parâmetro será definido como `Int.max`. Depois que uma solicitação inicial é feita para a instância ServiceNow, o número de páginas é atualizado para o número real de páginas recebidas da instância ServiceNow. |
| página | Inteiro | Página atual no conjunto de registros paginados. |
| editor | Cadeia de caracteres | Fornecedor que fornece o fluxo de dados paginados aos assinantes. Nota: Por padrão, o fornecedor não termina. Para mudar esse comportamento, defina a propriedade publisherShouldFinish como `verdadeira`. |
| publicadorDeveTermina | Booliano | Sinalizador que indica se o publicador do objeto Paginator deve ser interrompido quando a última página for obtida. Um objeto Paginator não pode buscar páginas após a conclusão. Valores válidos: * verdadeiro: depois que a última página é buscada, o fornecedor está liberado para fornecer dados adicionais. O método redefinir () não é mais funcional. * falso: o fornecedor nunca é concluído e todos os métodos estão totalmente operacionais, independentemente da navegação. Padrão: falso |
[Tabela 1. Propriedades]

{#PaginatorIOSAPI__table_vx2_klw_5pb}

## Paginador - lançamentos first() {#ariaid-title2}

Busca a primeira página dos resultados de retorno.
Se este método não puder buscar a primeira página, ele emitirá um `PaginationError`.
{#Paginator-first__table_fpc_bgv_kqb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 2. Parâmetros]

{#Paginator-first__table_fpc_bgv_kqb} {#Paginator-first__table_gpc_bgv_kqb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Retorna]

{#Paginator-first__table_gpc_bgv_kqb}  
O exemplo de código a seguir mostra como chamar este método.

    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)
        }
      }
    }

## Paginador - lançamentos de last() {#ariaid-title3}

Busca a última página dos resultados retornados.
Se este método não puder buscar a última página, ele emitirá um `PaginationError`.
{#Paginator-last__table_ipy_hgv_kqb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 4. Parâmetros]

{#Paginator-last__table_ipy_hgv_kqb} {#Paginator-last__table_jpy_hgv_kqb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Retorna]

{#Paginator-last__table_jpy_hgv_kqb}  
O exemplo de código a seguir mostra como chamar este método.

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

## Paginador - lançamentos de next() {#ariaid-title4}

Busca a próxima página dos resultados de retorno.
Se não houver mais páginas para buscar, o método emitirá um `PaginationError`.
{#Paginator-next__table_kj5_5cv_kqb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 6. Parâmetros]

{#Paginator-next__table_kj5_5cv_kqb} {#Paginator-next__table_lj5_5cv_kqb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 7. Retorna]

{#Paginator-next__table_lj5_5cv_kqb}  
O exemplo de código a seguir mostra como chamar este método.

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

## Paginador - lançamentos anteriores () {#ariaid-title5}

Busca a página anterior dos resultados retornados.
Se o método não puder buscar a página anterior, ele emitirá um `PaginationError`.
{#Paginator-previous__table_lby_sfv_kqb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 8. Parâmetros]

{#Paginator-previous__table_lby_sfv_kqb} {#Paginator-previous__table_mby_sfv_kqb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Retorna]

{#Paginator-previous__table_mby_sfv_kqb}  
O exemplo de código a seguir mostra como chamar este método.

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

## Paginador - redefinir() {#ariaid-title6}

Redefine o Paginador de volta para a primeira página, mas não retorna a primeira página dos resultados de retorno.
{#Paginator-reset__table_u1y_mgv_kqb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 10. Parâmetros]

{#Paginator-reset__table_u1y_mgv_kqb} {#Paginator-reset__table_v1y_mgv_kqb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Retorna]

{#Paginator-reset__table_v1y_mgv_kqb}  
O exemplo de código a seguir mostra como chamar este método.

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