REST API による Salesforce データへのアクセス

アプリケーションで Salesforce データにアクセスする準備が整ったら、Salesforce REST API をコールします。一般的に REST API は低レベルであるため、開発者は基本的なネットワークコールを使用して手動でアクセスできますが、その必要はありません。Mobile SDK によって面倒な作業が処理されるためです。

REST API コールを処理するクラスの概要を次に示します。これらのクラスはすべて com.salesforce.androidsdk.rest パッケージに含まれています。

• ClientManager — RestClient インスタンスのファクトリーとして機能します。また、アカウントログインや Salesforce サーバーとのハンドシェイクも処理します。
• RestClient — REST API 要求を Salesforce サーバーに送信するためのプロトコルを処理します。

  RestClient のインスタンスを直接作成しないでください。代わりに、ClientManager.getRestClient() メソッドをコールします。

• RestRequest — 提供したデータに基づいて書式設定された REST API 要求を表します。また、自身のインスタンスのファクトリーとしても機能します。
  

  重要

  RestRequest のインスタンスを直接作成しないでください。代わりに、適切な RestRequest の静的 getter 関数 (RestRequest.getRequestForCreate() など) をコールします。

• RestResponse — 要求された書式での応答コンテンツを含みます。RestRequest クラスは、RestResponse のインスタンスを作成し、RestClient.AsyncRequestCallback インターフェースの実装を介してアプリケーションに返します。

次に、このフローの動作を示すアニメーションダイアグラムを示します。

1. アプリケーションは、RestRequest クラスの静的メソッドをコールし、設定された RestRequest インスタンスを作成します。
2. アプリケーションは、新しい RestRequest インスタンスと AsyncRequestCallback インターフェースのインスタンスを RestClient.sendAsync() メソッドに渡します。
3. Mobile SDK は、RestRequest オブジェクトで示された REST 要求を Salesforce クラウドサービスに送信します。
4. Salesforce は要求を処理し、JSON 応答をアプリケーションに返します。
5. Mobile SDK は、新しい RestResponse オブジェクトで JSON 応答をパッケージ化します。
6. Mobile SDK は、使用できるように新しい RestResponse オブジェクトをアプリケーションの AsyncRequestCallback 実装に渡します。

まだ起きていますか? 概念的なレベルを越えて、この情報が動作しているところを実際のアプリケーションで見てみましょう。

RestRequest restRequest = 
    RestRequest.getRequestForQuery(
        getString(R.string.api_version), soql); 

client.sendAsync(restRequest, new AsyncRequestCallback()
    { 
    ...

@Override
public void onSuccess(RestRequest request,
    final RestResponse result) {
    result.consumeQuietly(); // consume before going back to main thread
    runOnUiThread(new Runnable() {
        @Override
        public void run() { 
            try {
                listAdapter.clear();
                JSONArray records = 
                    result.asJSONObject().getJSONArray("records");
                for (int i = 0; i < records.length(); i++) {
                    listAdapter.add(
                        records.getJSONObject(i).getString("Name"));
                } 
             } catch (Exception e) {
                 onError(e);
             }
        }
    });
}

@Override
public void onError(Exception exception)
{
    runOnUiThread((new Runnable() {
        @Override
        public void run() {
            Toast.makeText(MainActivity.this,
            MainActivity.this.getString(R.string.sf__generic_error, 
                exception.toString()),
            Toast.LENGTH_LONG).show();
        }
    });
}

• REST API 開発者ガイド
• REST API の使用
• RestClient クラス
• RestRequest クラス
• Postman 学習センター