Paginator-Klasse – Android

Die Paginator -Klasse bietet Funktionen zum Durchblättern der von einem REST-Endpunkt zurückgegebenen Ergebnisse, z. B. diejenigen, die von der NowTableService -Klasse zurückgegeben werden.

Sie müssen zuerst die Funktion NowTableService – paginator(from tableName: String, configuration: FetchConfiguration? = nil) oder NowTableService – paginator<Model: Decodable> (aus tableName: Zeichenfolge, Pfad: Zeichenfolge = Constants.resultPath, Codierer: Codierer = .default, Konfiguration: FetchConfiguration? = nil) aufrufen, um die Paginierungsergebnisse abzurufen.

Paginator – first()

Ruft die erste Seite der Rückgabeergebnisse ab.

Die Methode löst einen PaginationError aus, wenn die erste Seite nicht abgerufen werden kann.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 2. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  paginator.first()
}

Paginator – hasNext()

Überprüft, ob in den zurückgegebenen Ergebnissen eine nächste Seite vorhanden ist.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob in den zurückgegebenen Ergebnissen eine nächste Seite vorhanden ist. Mögliche Werte: true: Nächste Seite verfügbar. false: Keine nächste Seite verfügbar.

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if (paginator.hasNext() && !paginator.isBusy()) {
    paginator.next()
  }
}

Paginator – hasPrevious()

Überprüft, ob in den zurückgegebenen Ergebnissen eine vorherige Seite vorhanden ist.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 6. Ergebnisse

Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob in den zurückgegebenen Ergebnissen eine vorherige Seite vorhanden ist. Mögliche Werte: true: Vorherige Seite verfügbar. false: Keine vorherige Seite verfügbar.

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if (paginator.hasPrevious() && !paginator.isBusy()) {
    paginator.previous()
  }
}

Paginator – isBusy()

Überprüft, ob der Paginator mit dem Abrufen von Daten ausgelastet ist.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 8. Ergebnisse

Typ	Beschreibung
Keine	Kennzeichnung, die angibt, ob der Paginator mit dem Abrufen von Daten ausgelastet ist. Mögliche Werte: true: Daten werden abgerufen. false: Nicht ausgelastet.

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if (paginator.hasNext() && !paginator.isBusy()) {
    paginator.next()
  }
}

Paginator – last()

Ruft die letzte Seite der zurückgegebenen Ergebnisse ab.

Die Methode löst einen PaginationError aus, wenn die letzte Seite nicht abgerufen werden kann.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 10. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if !paginator.isBusy()) {
    paginator.last()
  }
}

Paginator – next()

Ruft die nächste Seite der Rückgabeergebnisse ab.

Die Methode löst einen PaginationError aus, wenn keine weiteren Seiten abzurufen sind.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 12. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if (paginator.hasNext() && !paginator.isBusy()) {
    paginator.next()
  }
}

Paginator – observ(callback: PaginatorCallBack<T> )

Legt die Rückrufe des Paginator-Objekts fest. Sie müssen diese Methode aufrufen, bevor Sie andere Paginator-Funktionen aufrufen.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
Rückruf	PaginatorCallBack	Rückrufe, die basierend auf dem Erfolg oder Misserfolg der Paginator-Erstellung aufgerufen werden sollen. Erfolg: abstrakter Spass onSuccess(Antwort: Antwort<List<T> >) Fehler: abstrakter Fun onFailure(e: NowDataError)

Tabelle : 14. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginationCallBack = object : PaginatorCallBack<NowAttachmentMetadata> {
    override fun onFailure(e: NowDataError) {
      handleError(e)
    }

    override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
      handleResponse(response)
    }

  }

  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(paginationCallBack)
    ?: throw Exception("Response is null")
}

Paginator – previous()

Ruft die vorherige Seite der Rückgabeergebnisse ab.

Die Methode löst einen PaginationError aus, wenn die vorherige Seite nicht abgerufen werden kann.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 16. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  if (paginator.hasPrevious() && !paginator.isBusy()) {
    paginator.previous()
  }
}

Paginator – Reset()

Setzt den Paginator auf die erste Seite zurück, gibt jedoch nicht die erste Seite der Rückgabeergebnisse zurück.

Tabelle : 17. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 18. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

suspend fun createAttachmentMetadataPaginator() {
  val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(null, 10)
    ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
      override fun onFailure(e: NowDataError) {
        handleError(e)
      }

      override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
        handleResponse(response)
      }

    })
    ?: throw Exception("Response is null")

  paginator.reset()
}