setParametersAsJSON(jsonString)

署名

public void setParametersAsJSON(String jsonString)

パラメーター

jsonString

型: String

設定する必要があるカスタムパラメーター (JSON 形式の文字列にシリアライズされる)。

戻り値

型: Void

使用方法

このメソッドを使用して、キャンバスアプリケーションの現在のカスタムパラメーターを設定します。パラメーターは JSON 文字列で指定する必要があります。System.JSON.serialize(objectToSerialize) メソッドを使用して、対応付けを JSON 文字列にシリアライズできます。

カスタムパラメーターを設定すると、現在の要求に設定されているカスタムパラメーターが上書きされます。現在のカスタムパラメーターを変更する必要がある場合、まず getParametersAsJSON() を使用して現在のカスタムパラメーターのセットを取得し、必要に応じて、取得したパラメーターセットを変更します。次に、変更したこのセットを setParametersAsJSON() へのコールで使用します。

指定された JSON 文字列が 32KB を超えると、System.CanvasException が発生します。

例

この例では、現在のカスタムパラメーターを取得し、「TESTVALUE」の値で新しい newCustomParam パラメーターを追加して、現在のカスタムパラメーターを設定します。