ウィジェット API リファレンス
サービスポータル には、ウィジェットクライアントとサーバースクリプトで使用するクライアントとサーバー側の API が含まれています。
サービスポータル クライアント側 API
ウィジェットクライアントコントローラーで使用できる サービスポータル API 。
クラスとメソッドの詳細については、API リファレンスを参照してください。
| クラス | 説明 |
|---|---|
| spAriaUtil | メッセージをスクリーンリーダーに表示します。 |
| spContextManager | サービスポータルウィジェットのデータを、サービスポータルページ内の他のアプリケーションやサービスで利用できるようにします。たとえば、ウィジェットデータがサービスポータルページで開いた際に、エージェントチャットにウィジェットデータを渡します。 |
| spUtil | サービスポータルのウィジェットクライアントスクリプトで共通する関数を実行する有用性メソッド。 |
| spModal | サービスポータルウィジェットにアラート、プロンプト、および確認ダイアログを表示します。spModal クラスは、サービスポータルクライアントスクリプトで使用できます。 |
サービスポータル サーバー側 API
ウィジェットサーバースクリプトで使用できる サービスポータル API。
| クラス | 説明 |
|---|---|
| GlideSPScriptable | GlideSPScriptable API は、サービスポータルウィジェットでデータを操作し、レコード操作を実行するためのメソッドを提供します。 |
| GlideSPSearchAnalytics | GlideSPSearchAnalytics API は、カスタムServiceNow検索ウィジェットから検索アナリティクスを生成するメソッドを提供します。 |
| SPScriptedFacet - Scoped | ファセットオブジェクトのファセットアイテム、フィルター、またはマッピングされたクエリを定義します。 |
| SPScriptedFacetService - Scoped | 詳細検索ソースの複数選択肢または単一選択肢のファセットオブジェクトを生成します。 |
| SPSEOUtilsSNC - Global | トランザクション要求に基づいて、特定のページまたは現在のページの人間が判読できる URL を返します。 |
| SPWidgetAccessControl - Global | 指定されたテーブルにウィジェットへのアクセス権が付与されているかどうかを確認し、対象者がウィジェットに安全にアクセスできるようにします。 |
ウィジェットのプロパティ
ウィジェット クライアントおよびサーバー スクリプトで使用可能なグローバル変数と関数です。
サーバー スクリプトのグローバル オブジェクト
| プロパティ | 説明 |
|---|---|
input |
c.data で設定されているクライアント側のプロパティを含むオブジェクトです。クライアント コントローラーが c.server.update() を呼び出すまで、値は undefined です。 |
data |
サーバー側での実行中に設定されたプロパティを含むオブジェクトです。 |
options |
スキーマ オプションのプロパティを含むオブジェクトです。 |
クライアント スクリプトのグローバル関数
| プロパティ | 説明 |
|---|---|
this.server.get([Object]) |
サーバーを呼び出し、カスタム input を送信します。Promise を返します。 |
this.server.update() |
サーバーを呼び出し、this.data をサーバー スクリプトに投稿します。Promise を返します。 |
this.server.refresh() |
サーバーを呼び出し、サーバーの応答から取得された現在のオプションとデータを自動的に置き換えます。Promise を返します。 |
promise は、非同期操作の最終結果を表します。promise の詳細については、「https://promisesaplus.com/」または AngularJS のドキュメントを参照してください。