GlideList (ネクストエクスペリエンス): クライアント

GlideList API は、ネクストエクスペリエンス UI フレームワークのリストをカスタマイズするメソッドを提供します。

この API を使用すると、ワークスペースエクスペリエンス UI のボタンに GlideList 機能を追加できます。g_list 変数を使用して各メソッドを呼び出します。

ボタンを追加するには、リストアクションを作成し、 GlideList メソッド呼び出しを クライアントスクリプト フィールド の onClick{} メソッドに追加します。手順については、「 ワークスペースエクスペリエンス UI でのクライアント GlideList API の使用」を参照してください。

注:

各メソッドは、sort() メソッドと sortDescending() メソッドを除いて、refresh() メソッドと一緒に使用する必要があります。

この API のメソッドは GlideList2 に基づいています。次の GlideList2 メソッドは ネクストエクスペリエンス フレームワークではサポートされていないため、コンソールログにエラーが発生します。

• isUserList()
• setFirstRow()
• showHideGroups()
• showHideList()
• toggleList()
• toggleListNoPref()

GlideList (ネクストエクスペリエンス):addFilter (文字列フィルター)

単一の用語をクエリフィルターのリストに追加します。

setFilter() も参照してください。

表 : 1. パラメーター

名前	タイプ	説明
filter	文字列	標準の Glide 形式のエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。

表 : 2. 返される内容

タイプ	説明
なし

次の例は、アクティブなレコードリストを取得してページを更新する方法を示しています。

g_list.addFilter("active=true");
g_list.refresh();

GlideList (ネクストエクスペリエンス):getChecked()

関連するリストでチェックされたアイテムの sys_id のカンマ区切りリストを返します。

表 : 3. パラメーター

名前	タイプ	説明
なし

表 : 4. 返される内容

タイプ	説明
文字列	リストでチェックされたアイテムの sys_id のカンマ区切りリスト。返されたアイテムの実行が許可されているかどうかを確認しません。

次の例は、リストで選択された各レコードの sys_id を取得する方法を示しています。

var myChecked = g_list.getChecked();
alert(myChecked);
g_list.refresh();

アラートボックスへの出力 (レコードが選択されていない場合は空)：

079893e6b733330059128ac7ee11a967, 4fca6d45b7131010f03e9b7ade11a9d3, 5c460fbf1bd0011079e52131604bcbd9

GlideList (ネクストエクスペリエンス):getFixedQuery()

固定クエリを返します。

固定クエリは、ブレッドクラムから削除できないクエリの一部です (つまりユーザーに対して固定されています)。

ワークスペースエクスペリエンス UI の [関連リストアクション] でこのメソッドを適用します。手順については、「 ワークスペースエクスペリエンス UI でのクライアント GlideList API の使用」を参照してください。

表 : 5. パラメーター

名前	タイプ	説明
なし

表 : 6. 返される内容

タイプ	説明
文字列	リストの固定クエリ文字列。

次の例は、ブラウザーコンソールログにデバッグメッセージを含む固定クエリを表示する方法を示しています。

console.log(g_list.getFixedQuery() + " debug message");

インシデントレコードの [子インシデント] タブのボタンをクリックした後の出力。

parent_incident=46f1784ba9fe19810018aa27fbb23482 debug message

GlideList (ネクストエクスペリエンス):getGroupBy()

リストをグループ化するために使用されるフィールドまたはフィールドのカンマ区切りリストを返します。

関連項目：

• getQuery()
• setGroupBy()

表 : 7. パラメーター

名前	タイプ	説明
なし

表 : 8. 返される内容

タイプ	説明
文字列	リストをグループ化するために使用されるフィールドまたはフィールドのカンマ区切りリスト。

次の例は、現在のリストビューのフィールド groupBy 値を取得する方法を示しています。

var grpdBy = g_list.getGroupBy();
alert("The list is grouped by " + grpdBy);
g_list.refresh();

優先度別にグループ化されたリストのアラートボックスの出力：

The list is grouped by ^GROUPBYpriority

GlideList (ネクストエクスペリエンス):getListName()

通常はテーブル名であるリストの名前を返します。

表 : 9. パラメーター

名前	タイプ	説明
なし

表 : 10. 返される内容

タイプ	説明
文字列	リスト名 (通常はテーブル名)。

次の例はメソッドを呼び出す方法を示しています。

g_list.getListName();

GlideList (ネクストエクスペリエンス):getOrderBy()

リストの順序付けに使用される最初のフィールドを返します。

関連項目：

• getQuery()
• setOrderBy()

表 : 11. パラメーター

名前	タイプ	説明
なし

表 : 12. 返される内容

タイプ	説明
文字列	リストの順序付けの基準となるフィールド。リストが順序付けされていない場合は空です。

次の例は、現在のリストビューのフィールド orderBy 値を取得する方法を示しています。

var orderBy = g_list.getOrderBy();
	
alert("The list is ordered by " + orderBy);
g_list.refresh();

優先度順に並べられたリストのアラートボックスの出力：

The list is ordered by ^ORDERBYDESCpriority

GlideList (ネクストエクスペリエンス):getParentTable()

関連リスト (フォームに関連付けられたテーブル) の親テーブルの名前を返します。

表 : 13. パラメーター

名前	タイプ	説明
なし

表 : 14. 返される内容

タイプ	説明
文字列	親テーブル名。

次の例はメソッドを呼び出す方法を示しています。

g_list.getParentTable();
g_list.refresh();

GlideList (ネクストエクスペリエンス):getQuery(Object)

リストのエンコードされたクエリ文字列を返します。

関連項目：

• getFixedQuery()
• getGroupBy()
• getOrderBy()
• setGroupBy()
• setOrderBy()

表 : 15. パラメーター

名前	タイプ	説明
<object>	オブジェクト	オプション。デフォルトでは、このメソッドの結果には orderBy、groupBy、および固定クエリが含まれます。オブジェクトプロパティを設定して、3 つの利用可能なオプションのうち 1 つ以上に結果を制限できます。
<object>.orderBy	ブーリアン	オプション。結果に orderBy を含めるかどうかを示すフラグ。 有効な値： true：結果に orderBy を含めます。 false：結果に orderBy を含めません。 デフォルト値：false
<object>.groupBy	ブーリアン	オプション。結果に groupBy を含めるかどうかを示すフラグ。 有効な値： true：結果に groupBy を含めます。 false：結果に groupBy を含めません。 デフォルト値：false
<object>.fixed	ブーリアン	オプション。結果に固定クエリを含めるかどうかを示すフラグ。 有効な値： true：結果に固定クエリを含めます。 false：結果に固定クエリを含めません。 デフォルト値：false

表 : 16. 返される内容

タイプ	説明
文字列	リストのエンコードされたクエリ文字列。

次の例は、ブラウザーコンソールログにデバッグメッセージを含むリストのエンコードされたクエリを表示する方法を示しています。

var myQuery = g_list.getQuery();
console.log(myQuery + " message");

出力：

active=false^EQ message

GlideList (ネクストエクスペリエンス):getRelated()

関連リストを親フォームに関連付ける関連リストフィールドを返します。

表 : 17. パラメーター

名前	タイプ	説明
なし

表 : 18. 返される内容

タイプ	説明
文字列	リストを親フォームに接続するフィールド。

次の例はメソッドを呼び出す方法を示しています。

g_list.getRelated();

GlideList (ネクストエクスペリエンス):getTableName()

リストのテーブル名を返します。

表 : 19. パラメーター

名前	タイプ	説明
なし

表 : 20. 返される内容

タイプ	説明
文字列	リストのテーブル名を返します。

次の例は、現在のビューのリスト名を表示する方法を示しています。

var listName = g_list.getListName();
alert("The current list name is " + listName);
g_list.refresh();

アラートボックスの出力：

The current list name is incident

GlideList (ネクストエクスペリエンス) - getTitle()

リストのタイトルを返します。

表 : 21. パラメーター

名前	タイプ	説明
なし

表 : 22. 返される内容

タイプ	説明
文字列	リストのタイトル。

次の例はメソッドを呼び出す方法を示しています。

g_list.getTitle();

GlideList (ネクストエクスペリエンス):getView()

リストを表示するために使用するビューを返します。

表 : 23. パラメーター

名前	タイプ	説明
なし

表 : 24. 返される内容

タイプ	説明
文字列	ビューの名前。

次の例はメソッドを呼び出す方法を示しています。

g_list.getView();

GlideList (ネクストエクスペリエンス) - refresh(数値 firstRow)

リストを更新します。リストフィルターの orderBy 部分は無視されるため、リストは更新されたときに自然な順序付けを使用します。

表 : 25. パラメーター

名前	タイプ	説明
firstRow	番号	リストに表示される最初の行。 デフォルト：現在のビューの最初の行。

表 : 26. 返される内容

タイプ	説明
なし

次の例はメソッドを呼び出す方法を示しています。

g_list.addFilter("active=true");
g_list.refresh();

GlideList (ネクストエクスペリエンス):refreshWithOrderBy(番号 firstRow)

リストを更新します。リストに対して指定されている場合は、リストフィルターの orderBy 部分が含まれます。

表 : 27. パラメーター

名前	タイプ	説明
firstRow	番号	リストに表示される最初の行。 デフォルト：現在のビューの最初の行。

表 : 28. 返される内容

タイプ	説明
なし

次の例はメソッドを呼び出す方法を示しています。

g_list.refreshWithOrderBy();

GlideList (ネクストエクスペリエンス) - setFilter (文字列フィルター)

クエリ文字列の orderBy と groupBy の部分を無視して、リストのエンコードされたクエリ文字列を設定します。

addFilter() も参照してください。

表 : 29. パラメーター

名前	タイプ	説明
filter	文字列	標準の Glide 形式のエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。

表 : 30. 返される内容

タイプ	説明
なし

次の例は、リストの結果をアクティブなレコードに制限する方法を示しています。

g_list.setFilter("active=true");
g_list.refresh();

GlideList (ネクストエクスペリエンス):setGroupBy(文字列 groupBy)

単一のフィールドのリスト groupBy 条件を設定します。

関連項目：

• getGroupBy()
• getQuery()

表 : 31. パラメーター

名前	タイプ	説明
groupBy	文字列	リストの groupBy 基準。

表 : 32. 返される内容

タイプ	説明
なし

次の例は、リストされたレコードを問い合わせユーザー ID でグループ化する方法を示しています。

g_list.setGroupBy("caller_id");
g_list.refresh();

GlideList (ネクストエクスペリエンス) - setOrderBy(文字列 orderBy)

リストの orderBy 条件を設定します。

単一の順序付けフィールドの場合は、orderBy フィールドまたは orderByDesc フィールドを使用します。複数のフィールドの場合は、orderByField1^orderByField2^orderByField3 を使用します。orderBy は昇順を指定し、orderByDesc は降順を指定します。これらのプレフィックス文字列はオプションです。指定しない場合、orderBy がデフォルトの順序になります。

関連項目：

• getOrderBy()
• getQuery()
• sort()
• sortDescending()

表 : 33. パラメーター

名前	タイプ	説明
orderBy	文字列	1 つまたは複数の orderBy フィールド。

表 : 34. 返される内容

タイプ	説明
なし

次の例は、 [優先度] フィールドの値でリストを並べ替える方法を示しています。

g_list.setOrderBy("priority");
g_list.refresh();

GlideList (ネクストエクスペリエンス):setRowsPerPage(行数)

表示する 1 ページあたりの行数を設定します。

表 : 35. パラメーター

名前	タイプ	説明
rows	数値	表示する行数。

表 : 36. 返される内容

タイプ	説明
なし

次の例は、結果をページあたり 50 行に制限する方法を示しています。

g_list.setRowsPerPage(50);
refresh();

GlideList (ネクストエクスペリエンス) - ソート (文字列フィールド)

リストを昇順でソートし、フィールドを orderBy 列として設定します。

関連項目：

• getOrderBy()
• getQuery()
• setOrderBy()
• sortDescending()

注:

このメソッドに refresh() メソッドは必要ありません。

表 : 37. パラメーター

名前	タイプ	説明
フィールド	文字列	リストのソートに使用するフィールド。

表 : 38. 返される内容

タイプ	説明
なし

次の例は、[数値] フィールドによって結果をソートする方法を示しています。

g_list.sort("number");

GlideList (ネクストエクスペリエンス) - sortDescending(文字列フィールド, 数値)

リスト内の 1 つのフィールドを降順でソートし、フィールドを orderByDescField 列として設定します。

関連項目：

• getOrderBy()
• getQuery()
• setOrderBy()
• sortDescending()

注:

このメソッドに refresh() メソッドは必要ありません。

表 : 39. パラメーター

名前	タイプ	説明
フィールド	文字列	リストのソートに使用するフィールド。

表 : 40. 返される内容

タイプ	説明
なし

次の例は、[数値] フィールドによって結果を降順にソートする方法を示しています。

g_list.sortDescending("number");