IncludeJavascript API
環境内で実行されているすべてのWebアプリのWeb画面にスクリプトを含めるためのAPI。
このAPIを使用するには、Service Studioの［References］ウィンドウを使用してIncludeJavascript_APIエクステンションを参照します。
概要
| アクション | 説明 |
|---|---|
| Application_AddExclusionRule | スクリプトの除外ルールを作成します。指定されたスクリプトは指定されたアプリケーションに含められません。 |
| Application_RemoveExclusionRule | スクリプトの除外ルールを削除します。指定されたスクリプトは指定されたアプリケーションに含められます。 |
| Espace_AddExclusionRule | スクリプトの除外ルールを作成します。指定されたスクリプトは指定されたモジュールに含められません。 |
| Espace_RemoveExclusionRule | スクリプト除外ルールを削除します。指定されたスクリプトは指定されたモジュールに含められます。 |
| Script_CreateOrUpdate | JavaScriptを作成または更新します。すべてのeSpaceモジュールのすべてのWeb画面のHTMLにスクリプトが挿入されます。 スクリプト名がすでに存在している場合はスクリプトが更新され、存在していない場合は新しいスクリプトが作成されます。 |
| Script_Delete | スクリプトを削除します。このスクリプトはWeb画面に含められなくなります。 |
| Script_Get | スクリプトの情報を返します。 |
| Script_List | Web画面に含めるスクリプトのリストを返します。 |
| Script_SetActive | Web画面に含める特定のスクリプトを有効化します。 |
| Script_SetInactive | 特定のスクリプトを無効化します。このスクリプトはWeb画面に含められません。 |
| ストラクチャ | 説明 |
|---|---|
| ExcludedApplications | 特定のアプリケーションの除外ルールを表します。除外ルールでは、スクリプトを挿入しないアプリケーションを指定します。 |
| ExcludedEspaces | 特定のモジュールの除外ルールを表します。除外ルールでは、スクリプトを挿入しないモジュールを指定します。 |
| JavaScript | Web画面のHTMLに含めるスクリプトを表します。 |
アクション
Application_AddExclusionRule
スクリプトの除外ルールを作成します。指定されたスクリプトは指定されたアプリケーションに含められません。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。 - ApplicationKey
- 型: Text。必須。
アプリケーションの一意のキー。
Application_RemoveExclusionRule
スクリプトの除外ルールを削除します。指定されたスクリプトは指定されたアプリケーションに含められます。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。 - ApplicationKey
- 型: Text。必須。
アプリケーションの一意のキー。
Espace_AddExclusionRule
スクリプトの除外ルールを作成します。指定されたスクリプトは指定されたモジュールに含められません。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。 - EspaceKey
- 型: Text。必須。
モジュールの一意のキー。
Espace_RemoveExclusionRule
スクリプトの除外ルールを削除します。指定されたスクリプトは指定されたモジュールに含められます。
入力
- ScriptName
- 型: Text。必須。
含めるスクリプトの名前。 - EspaceKey
- 型: Text。必須。
モジュールの一意のキー。
Script_CreateOrUpdate
JavaScriptを作成または更新します。すべてのモジュールのすべてのWeb画面のHTMLにスクリプトが挿入されます。
スクリプト名がすでに存在している場合はスクリプトが更新され、存在していない場合は新しいスクリプトが作成されます。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。 - ScriptOrURL
- 型: Text。必須。
インラインスクリプトまたはスクリプトの場所を指定するURL。isUrlパラメータに適合するには、このパラメータが必要です。 - IncludeAt
- 型: Text。必須。
スクリプトを含めるHTML内の場所。有効な場所は「HeadTop」、「HeadBottom」、「BodyTop」、「BodyBottom」です。 - Order
- 型: Integer。
スクリプトをWeb画面またはWebブロックに含める順序を指定します。 - 説明
- 型: Text。
スクリプトのドキュメント。
Script_Delete
スクリプトを削除します。スクリプトはWeb画面に含められなくなります。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。
Script_Get
スクリプトの情報を返します。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。
出力
- JavaScript
- 型: JavaScriptのレコード。
Web画面に含めるスクリプト。
Script_List
Web画面に含めるスクリプトのリストを返します。
入力
- ShowInactive
- 型: Boolean。必須。
Trueの場合、非アクティブとしてマークされたものも含めてすべてのスクリプトを返します。
出力
- JavaScriptList
- 型: JavaScriptのレコードリスト。
スクリプトのリスト。
Script_SetActive
Web画面に含める特定のスクリプトを有効化します。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。
Script_SetInactive
特定のスクリプトを無効化します。このスクリプトはWeb画面に含められません。
入力
- ScriptName
- 型: Text。必須。
スクリプトの名前。
ストラクチャ
ExcludedApplications
特定のアプリケーションの除外ルールを表します。除外ルールでは、スクリプトを挿入しないアプリケーションを指定します。
アトリビュート
- ApplicationKey
- 型: Text (50)。必須。
アプリケーションの一意のキー。 - ApplicationName
- 型: Text (50)。必須。
アプリケーションの名前。
ExcludedEspaces
特定のモジュールの除外ルールを表します。除外ルールでは、スクリプトを挿入しないモジュールを指定します。
アトリビュート
- EspaceKey
- 型: Text (50)。必須。
モジュールの一意のキー。 - EspaceName
- 型: Text (50)。必須。
モジュールの名前。
JavaScript
Web画面のHTMLに含めるスクリプトを表します。
アトリビュート
- Name
- 型: Text (50)。必須。
スクリプトの名前。 - ScriptOrURL
- 型: Text (4096)。必須。
インラインスクリプトまたはスクリプトの場所を指定する絶対URL。 - IncludeAt
- 型: Text (50)。必須。
スクリプトを含めるHTML内の場所。有効な場所は「HeadTop」、「HeadBottom」、「BodyTop」、「BodyBottom」です。 - Order
- 型: Integer。
スクリプトをWeb画面またはWebブロックに含める順序を指定します。 - 説明
- 型: Text (50)。
スクリプトのドキュメント。 - IsActive
- 型: Boolean。必須。
スクリプトがグローバルで有効であるか無効であるかを示します。 - ExcludedApplications
- 型: ExcludedApplicationsのレコードリスト。必須。
これらのアプリケーションのWeb画面にはスクリプトが挿入されません。 - ExcludedEspaces
- 型: ExcludedEspacesのレコードリスト。必須。
これらのモジュールのWeb画面にはスクリプトが挿入されません。