GlideList (ネクストエクスペリエンス): クライアント
GlideList API は、ネクストエクスペリエンス UI フレームワークのリストをカスタマイズするメソッドを提供します。
この API を使用すると、 ワークスペースエクスペリエンス UI のボタンに GlideList 機能を追加できます。g_list変数を使用して、各メソッドを呼び出します。
ボタンを追加するには、リストアクションを作成し、 GlideList メソッド呼び出しを クライアントスクリプト フィールドの onClick{} メソッドに追加します。手順については、「 ワークスペースエクスペリエンス UI でのクライアント GlideList API の使用」を参照してください。
- isUserList()
- setFirstRow()
- showHideGroups()
- showHideList()
- toggleList()
- toggleListNoPref()
GlideList (ネクストエクスペリエンス):addFilter (文字列フィルター)
リストクエリフィルターに単一の用語を追加します。
setFilter() も参照してください。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィルター | 文字列 | 標準の Glide 形式でエンコードされたクエリ文字列。「 エンコードされたクエリ文字列」を参照してください。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、アクティブなレコードのリストを取得してページを更新する方法を示しています。
g_list.addFilter("active=true");
g_list.refresh();
GlideList (ネクストエクスペリエンス):getChecked()
関連付けられたリストでチェックされているアイテムのsys_idsのカンマ区切りリストを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストでチェックされているアイテムのsys_idsのカンマ区切りリスト。返されたアイテムの実行が許可されているかどうかをチェックして判断しません。 |
次の例は、リストで選択された各レコードのsys_idsを取得する方法を示しています。
var myChecked = g_list.getChecked();
alert(myChecked);
g_list.refresh();
アラートボックスに出力します (レコードが選択されていない場合は空):
079893e6b733330059128ac7ee11a967, 4fca6d45b7131010f03e9b7ade11a9d3, 5c460fbf1bd0011079e52131604bcbd9
GlideList (ネクストエクスペリエンス):getFixedQuery()
固定クエリを返します。
固定クエリは、ブレッドクラムから削除できない (つまり、ユーザーに対して固定されている) クエリの部分です。
ワークスペースエクスペリエンス UI の [関連リストアクション] でこのメソッドを適用します。手順については、「 ワークスペースエクスペリエンス UI でのクライアント GlideList API の使用」を参照してください。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストの固定クエリ文字列。 |
次の例は、ブラウザコンソールログにデバッグメッセージとともに固定クエリを表示する方法を示しています。
console.log(g_list.getFixedQuery() + " debug message");
インシデントレコードの [子インシデント] タブのボタンをクリックした後の出力。
parent_incident=46f1784ba9fe19810018aa27fbb23482 debug message
GlideList (ネクストエクスペリエンス):getGroupBy()
リストのグループ化に使用されるフィールドまたはカンマ区切りのフィールドリストを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストをグループ化するために使用されるフィールドまたはカンマ区切りのフィールドリスト。 |
次の例は、現在のリストビューのフィールド groupBy 値を取得する方法を示しています。
var grpdBy = g_list.getGroupBy();
alert("The list is grouped by " + grpdBy);
g_list.refresh();
優先度別にグループ化されたリストのアラートボックスの出力:
The list is grouped by ^GROUPBYpriority
GlideList (ネクストエクスペリエンス):getListName()
リストの名前 (通常はテーブル名) を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リスト名 (通常はテーブル名)。 |
次の例は、メソッドを呼び出す方法を示しています。
g_list.getListName();
GlideList (ネクストエクスペリエンス):getOrderBy()
リストの順序付けに使用する最初のフィールドを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストを並べ替えるフィールド。リストが順序付けされていない場合は空です。 |
次の例は、現在のリストビューのフィールド orderBy 値を取得する方法を示しています。
var orderBy = g_list.getOrderBy();
alert("The list is ordered by " + orderBy);
g_list.refresh();
優先度順に並べられたリストのアラートボックスの出力:
The list is ordered by ^ORDERBYDESCpriority
GlideList (ネクストエクスペリエンス):getParentTable()
関連リストの親テーブル (フォームに関連付けられたテーブル) の名前を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | 親テーブル名。 |
次の例は、メソッドを呼び出す方法を示しています。
g_list.getParentTable();
g_list.refresh();
GlideList (ネクストエクスペリエンス):getQuery(Object)
リストのエンコードされたクエリ文字列を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| <object> | オブジェクト | オプション。デフォルトでは、このメソッドの結果には orderBy、groupBy、および固定クエリが含まれます。オブジェクトプロパティを設定して、結果を利用可能な 3 つのオプションのうち 1 つ以上に制限できます。 |
| <object>.orderBy | ブーリアン | オプション。結果に orderBy を含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| <object>.groupBy | ブーリアン | オプション。結果に groupBy を含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| <object>.fixed | ブーリアン | オプション。結果に固定クエリを含めるかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのエンコードされたクエリ文字列。 |
次の例は、リストのエンコードされたクエリをデバッグメッセージとともにブラウザーコンソールログに表示する方法を示しています。
var myQuery = g_list.getQuery();
console.log(myQuery + " message");
出力:
active=false^EQ message
GlideList (ネクストエクスペリエンス):getRelated()
関連リストを親フォームに関連付ける関連リストフィールドを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストを親フォームに接続するフィールド。 |
次の例は、メソッドを呼び出す方法を示しています。
g_list.getRelated();
GlideList (ネクストエクスペリエンス):getTableName()
リストのテーブル名を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのテーブル名を返します。 |
次の例は、現在のビューのリスト名を表示する方法を示しています。
var listName = g_list.getListName();
alert("The current list name is " + listName);
g_list.refresh();
アラートボックスへの出力:
The current list name is incident
GlideList (ネクストエクスペリエンス) - getTitle()
リストのタイトルを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | リストのタイトル。 |
次の例は、メソッドを呼び出す方法を示しています。
g_list.getTitle();
GlideList (ネクストエクスペリエンス):getView()
リストの表示に使用するビューを返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
| タイプ | 説明 |
|---|---|
| 文字列 | ビューの名前。 |
次の例は、メソッドを呼び出す方法を示しています。
g_list.getView();
GlideList (ネクストエクスペリエンス) - refresh(数値 firstRow)
リストを更新します。リストフィルターの orderBy 部分は無視されるため、リストは更新時に自然な順序が使用されます。
| 名前 | タイプ | 説明 |
|---|---|---|
| 最初の行 | 番号 | リストに表示される最初の行。 デフォルト:現在のビューの最初の行。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、メソッドを呼び出す方法を示しています。
g_list.addFilter("active=true");
g_list.refresh();
GlideList (ネクストエクスペリエンス):refreshWithOrderBy(番号 firstRow)
リストを更新します。リストフィルターの orderBy 部分は、リストに指定されている場合に含まれます。
| 名前 | タイプ | 説明 |
|---|---|---|
| 最初の行 | 番号 | リストに表示される最初の行。 デフォルト:現在のビューの最初の行。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、メソッドを呼び出す方法を示しています。
g_list.refreshWithOrderBy();
GlideList (ネクストエクスペリエンス) - setFilter (文字列フィルター)
クエリ文字列の orderBy 部分と groupBy 部分を無視して、リストのエンコードされたクエリ文字列を設定します。
addFilter() も参照してください。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィルター | 文字列 | 標準の Glide 形式でエンコードされたクエリ文字列。「 エンコードされたクエリ文字列」を参照してください。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、リスト結果をアクティブなレコードに制限する方法を示しています。
g_list.setFilter("active=true");
g_list.refresh();
GlideList (ネクストエクスペリエンス):setGroupBy(文字列 groupBy)
単一フィールドのリスト groupBy 基準を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| groupBy | 文字列 | リストの groupBy 基準。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、リストされたレコードを発信者 ID でグループ化する方法を示しています。
g_list.setGroupBy("caller_id");
g_list.refresh();
GlideList (ネクストエクスペリエンス) - setOrderBy(文字列 orderBy)
リストの orderBy 基準を設定します。
単一の順番フィールドの場合は、 orderBy フィールドまたは orderByDesc フィールドを使用します。 複数のフィールドの場合は、 orderByField1^orderByField2^orderByField3 を使用します。 orderBy は昇順を指定し、orderByDesc は降順を指定します。これらのプリフィックス文字列はオプションです。指定しない場合は、 orderBy がデフォルトの順序になります。
| 名前 | タイプ | 説明 |
|---|---|---|
| orderBy | 文字列 | 単一または複数の orderBy フィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、[優先度] フィールドの値でリストを並べ替える方法を示しています。
g_list.setOrderBy("priority");
g_list.refresh();
GlideList (ネクストエクスペリエンス):setRowsPerPage(行数)
表示するページあたりの行数を設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| rows | 番号 | 表示する行数。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、結果数をページあたり 50 行に制限する方法を示しています。
g_list.setRowsPerPage(50);
refresh();
GlideList (ネクストエクスペリエンス) - ソート (文字列フィールド)
リストを昇順でソートし、フィールドを orderBy 列として設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィールド | 文字列 | リストをソートするために使用するフィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、[ 番号 ] フィールドで結果をソートする方法を示しています。
g_list.sort("number");
GlideList (ネクストエクスペリエンス) - sortDescending(文字列フィールド, 数値)
リスト内の単一のフィールドを降順でソートし、そのフィールドを orderByDescField 列として設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィールド | 文字列 | リストをソートするために使用するフィールド。 |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、[番号] フィールドで結果を降順でソートする方法を示しています。
g_list.sortDescending("number");