setCanvasUrlPath(newPath)

署名

public void setCanvasUrlPath(String newPath)

パラメータ

newPath

型: String

キャンバスアプリケーションの URL を上書きするために使用する必要がある URL (ドメインは含まない)。

戻り値

型: Void

使用方法

このメソッドを使用して、キャンバスアプリケーションの URL パスおよびクエリ文字列を上書きします。指定された URL 文字列は元のキャンバス URL ドメインに追加されるため、完全修飾 URL は指定しないでください。

たとえば、現在のキャンバスアプリケーション URL が https://myserver.com:6000/myAppPath の場合、setCanvasUrlPath('/alternatePath/args?arg1=1&arg2=2') をコールすると、調整されたキャンバスアプリケーション URL は https://myserver.com:6000/alternatePath/args?arg1=1&arg2=2 になります。

指定されたパスが不正な形式の URL、または 2,048 文字を超える URL になる場合、System.CanvasException が発生します。

このメソッドでは、現在の要求のキャンバスアプリケーション URL が上書きされますが、UI で Salesforce キャンバスアプリケーションを設定するときのようにキャンバスアプリケーション URL が永続的に変更されるわけではありません。