コールインターフェイス: Android

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:2分
  • 呼び出しインターフェイスは、処理用に準備された要求を表します。

    可能な処理オプションは次のとおりです。
    • キャンセル
    • キューに格納する
    • 実行
    • マップ

    コールオブジェクトを 2 回処理することはできません。

    表 : 1. プロパティ
    名前 タイプ 説明
    リクエスト 要求 このコールを開始した元の要求。

    呼び出し:cancel()

    可能であれば、関連するコールをキャンセルします (ベストエフォート)。

    表 : 2. パラメーター
    名前 タイプ 説明
    なし
    表 : 3. 戻り値
    タイプ 説明
    なし

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

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

    呼び出し:enqueue(onSuccess: Consumer<Response<T>>, onError: Consumer<NowDataError>)

    システムスレッドがこの要求を実行できるようになるとすぐに要求が実行されるようにスケジュールします。

    表 : 4. パラメーター
    名前 タイプ 説明
    成功時 Consumer<Response<T>> コールが成功した場合に実行するコールバック。T パラメーターで指定されたデータタイプに解析された本文を含む HTTP 応答。
    注:
    コンシューマーは、オブジェクトの非同期消費のための OOB Java タイプです。この場合、呼び出しはジェネリックを使用して型 Response<T を返します> ( T はオブジェクト型です)。
    エラー時 Consumer<NowDataError> コールが失敗した場合に実行するコールバック。

    Now データエラー

    表 : 5. 戻り値
    タイプ 説明
    なし

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

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

    呼び出し:execute()

    要求をすぐに呼び出します。応答が処理されるかエラーが発生するまでブロックします。

    表 : 6. パラメーター
    名前 タイプ 説明
    なし
    表 : 7. 戻り値
    タイプ 説明
    応答<T> Tパラメーターで定義された形式の応答データ。

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

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