Canvas 開発者ガイド
jClient
Client オブジェクトは、CanvasRequest オブジェクトの署名付き要求から返される JSON 形式のオブジェクトです。クライアントアプリケーションに関するコンテキスト情報が含まれます。
| 項目 | 説明 |
|---|---|
| instanceId | Visualforce ページで公開されるキャンバスアプリケーションの ID。キャンバスアプリケーションのインスタンス管理用に内部的に使用されます。 |
| instanceUrl | Salesforce インスタンスの URL。たとえば、http://instance.salesforce.com に保存されます。Links オブジェクトから返される URL の先頭を指定するために使用されます。 |
| oauthToken | コール元に返される OAuth アクセストークン。 |
| refreshToken | クライアントがセッションの認証に使用するトークン。この値は、キャンバスアプリケーションで、選択した OAuth 範囲のいずれかで [ユーザに代わっていつでも要求を実行 ] (refresh_token、offline_access) が設定されている場合にのみ返されます。それ以外の場合、null が返されます。 |
| targetOrigin | キャンバスアプリケーションの URL。ページとキャンバスアプリケーションを含む iFrame との間のクロスドメイン通信用に内部的に使用されます。 |
次のコードスニペットに、Client オブジェクトの例を示します。
1"client":
2{
3 "instanceId":"06Px000000002JZ",
4 "instanceUrl":"http://instance.salesforce.com:8080",
5 "oauthToken":"00Dx0000X00Or4J!ARQAQJ34YLUq54RMTrQbxVoWUgorjFi3...",
6 "refreshToken":"00DD0000000K1NM!ARAAQGJVGOyMjh1jjqvShRpLuAq0ke...",
7 "targetOrigin":"http://instance.salesforce.com:8080"
8}