Aufrufschnittstelle – Android

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Die Schnittstelle Anruf stellt eine Anforderung dar, die zur Verarbeitung vorbereitet wird.

    Mögliche Verarbeitungsoptionen:
    • abbrechen
    • Warteschlange
    • ausführen
    • Zuordnen

    Ein Anrufobjekt kann nicht zweimal verarbeitet werden.

    Tabelle : 1. Eigenschaften
    Name Typ Beschreibung
    Anforderung Anforderung Ursprüngliche Anforderung, die diesen Anruf initiiert hat.

    Anruf – abbrechen ()

    Bricht den zugeordneten Anruf ab, wenn möglich (nach bestem Wissen und Gewissen).

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    private var inFlightDataRequestCall: Call<*>? = null 
    fun cancelTransfer() = inFlightDataRequestCall?.cancel() 

    Anruf – enqueue(onSuccess: Consumer <Response<T> >, onError: Verbraucher<NowDataError> )

    Plant die Ausführung der Anforderung, sobald der System-\Thread zur Ausführung dieser Anforderung verfügbar ist.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    onSuccess Verbraucher<Response<T> > Auszuführender Rückruf, wenn der Anruf erfolgreich ist. HTTP-Antwort, wobei der Textkörper in den durch den Parameter T angegebenen Datentyp analysiert wird.
    Hinweis:
    Consumer ist ein OOB-Java-Typ für den asynchronen Verbrauch eines Objekts. In diesem Fall verwendet der Aufruf generische, um eine Antwort vom Typ zurückzugeben<T> wobei T der Objekttyp ist.
    onError Verbraucher<NowDataError> Auszuführender Rückruf, wenn der Anruf fehlschlägt.

    NowDataError

    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    fun makeGraphQLRequest(query: String) { 
      val call = graphQLService.graphQLRequest(query) 
      call.enqueue( 
        { response -> handleResponse(response) }, 
        { nowDataError -> handleError(nowDataError) } 
      ) 
    } 

    Aufruf - execute()

    Ruft die Anforderung sofort auf. Blockiert, bis die Antwort verarbeitet wird oder ein Fehler vorliegt.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Antwort<T> Antwortdaten in dem im Parameter T definierten Format.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    val response = apiService.data(NowAPIService.Endpoint( 
      relativePath = CASES_API, 
      requestMethod = HttpMethod.GET, 
      requireAuth = true) 
    ).execute()