呼び出しインターフェイス: Android

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:2分
  • Call インターフェイスは、処理の準備が整った要求を表します。

    次の処理オプションを指定できます。
    • キャンセル
    • エンキュー
    • 実行
    • マップ

    呼び出しオブジェクトを 2 回処理することはできません。

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

    呼び出し:cancel()

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

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

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

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

    Call - enqueue(onSuccess: Consumer<Response<T>>, onError: Consumer<NowDataError>)

    システム\スレッドがこの要求を実行可能になり次第、要求が実行されるようにスケジュールします。

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

    NowDataError

    表 : 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()