第4章 $fh.getFHParams

$fh.getFHParams();

このメソッドは、各クラウドリクエストについて FH SDK が追加したメタデータを返します。クラウドアプリとの通信に別のライブラリーを使用することを選択した場合は、このデータをリクエストボディまたはヘッダーに追加してください。クラウドアプリの url を取得する方法については、$fh.getCloudURL を参照してください。

通常は、メタデータを修正する必要は全くありません。参考のために、メタデータに含まれているキーを値を以下に示します。

  • appid: アプリの id
  • appkey: アプリの api キー
  • projectid: プロジェクトの id
  • cuid: クライアント用に生成された一意の id
  • destination: iOS、Android、ウェブなど、クライアントアプリが稼働しているプラットフォーム
  • sdk_version: sdk のバージョン
  • connectiontag: アプリの connectiontag

メタデータがリクエストボディで送信される場合は、特別キー "__fh" の値にしてください。下記の例を参照してください。

SDK によってはリクエストヘッダーとしてメタデータを提供するものもあります。この場合は、各ヘッダー名は "X-FH-appid" のように "X-FH-<meta data name>" という形式になります。

サポートされるプラットフォーム

  • JavaScript SDK

    • Cordova
    • Web Apps
  • Android SDK
  • iOS Objective-C SDK
  • iOS Swift SDK

  • .NET SDK

    • Windows
    • Xamarin

詳細なバージョン情報については、Supported Configurations (英語) を参照してください。

4.1. 例

JavaScript

var fhparams = $fh.getFHParams();
//then it should be added to your request body under the key "__fh"
body.__fh = fhparams;

Android (Java)

JSON オブジェクトとしてリクエストのメタデータを取得するには、以下を使用します。 

JSONObject fhParams = FH.getDefaultParams();

HTTP ヘッダーとしてメタデータを取得することもできます。 

Header[] fhParamHeaders = FH.getDefaultParamsAsHeaders(null);

iOS (Objective-C)

NSDictionary としてリクエストのメタデータを取得するには、以下を使用します。 

NSDictionary * fhParams = [FH getDefaultParams];

NSDictionary の HTTP ヘッダーとしてメタデータを取得することもできます。 

NSDictionary * fhParamHeaders = [FH getDefaultParamsAsHeaders];

 .NET (C#)

Dictionary としてリクエストのメタデータを取得するには、以下を使用します。 

  IDictionary <string, object> fhParams = FH.GetDefaultParams();

Dictionary の HTTP ヘッダーとしてメタデータを取得することもできます。 

IDictionary <string, string> fhParamHeaders = FH.GetDefaultParamsAsHeaders();