CatalogJS - スコープ付き

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：11分

    • CatalogJS API には、カタログ固有のプロパティを確認および取得するためのメソッドが用意されています。

    スコープ対象のアプリケーションでこのクラスを使用するには、sn_sc 名前空間識別子を使用します。デフォルトで有効になっている Service Catalog Scoped API プラグイン (com.glideapp.servicecatalog.scoped.api) は、CatalogJS API にアクセスするために必要です。

    CatalogJS - Catalog(GlideRecord now_GR)

    指定された Glide レコード オブジェクトのカタログ クラスのインスタンスを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    now_GR オブジェクト sc_catalog テーブルを指す Glide レコード

    この例は、Catalog クラスの新しいインスタンスを作成する方法を示しています。

    var now_GR = new GlideRecord('sc_catalog');
 now_GR.addQuery('sys_id','e0d08b13c3330100c8b837659bba8fb4');
 now_GR.query();
 var catalog = new sn_sc.Catalog(now_GR);

    CatalogJS Catalog(文字列 sys_id)

    指定された sys_id を使用して Catalog クラスのインスタンスを作成します。

    表 : 2. パラメーター
    名前 タイプ 説明
    sys_id 文字列 カタログの sys_id

    この例は、指定された sys_id を使用して Catalog クラスのインスタンスを作成する方法を示しています。

    new sn_sc.Catalog(catalog_sys_id);
var catalog = new sn_sc.Catalog("31bea3d53790200044e0bfc8bcbe5dec");

    CatalogJS - canView(ブール mobile, 文字列 userId)

    ユーザーが現在のカテゴリをモバイルデバイスまたはデスクトップで表示できるかどうかを決定します。

    表 : 3. パラメーター
    名前 タイプ 説明
    mobile ブーリアン

    ユーザーが現在のカタログをモバイルビューまたはデスクトップビューで表示できるかどうかを示すフラグ。

    有効な値：
    • true：モバイルビュー
    • false：デスクトップビュー
    userId 文字列 オプション。カタログを表示できるかどうかを確認するユーザーの sys_id。

    デフォルト：現在のユーザー
    表 : 4. 返される内容
    タイプ 説明
    ブーリアン

    カタログがユーザーによって表示可能かどうかを示すフラグ。

    有効な値：
    • true：カタログはユーザーによって表示可能です。
    • false：カタログはユーザーによって表示不可能です。

    例：

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.canView(true));

    出力：

    true

    CatalogJS - getAvailableCatalog()

    利用できるアクティブなカタログを返します。

    アクティブなカタログが 1 つしか存在しない場合、このメソッドはそのカタログを返します。それ以外の場合は、ユーザーが表示できるカタログのリストから、作成された最も古いカタログを返します。利用できるカタログがない場合、このメソッドは null を返します。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト ユーザーが表示できる最も古いカタログを指すオブジェクト。利用できるカタログがない場合は、null です。

    この例は、現在のユーザーが利用できるカタログを返します。

    var catalog = sn_sc.Catalog.getAvailableCatalog()

    CatalogJS - getBackgroundColor()

    カタログの背景色を返します。

    表 : 7. パラメーター
    名前 タイプ 説明
    なし
    表 : 8. 返される内容
    タイプ 説明
    文字列 カタログの背景色

    この例は、関連するカタログの背景色を返します。

    var catalog = new sn_sc.Catalog("0f910a2ac3112200b12d9f2974d3ae3c");
gs.info("Catalog background: " + catalog.getBackgroundColor());

    出力：

    Catalog background: white

    CatalogJS - getCatalogCount()

    カタログテーブルでアクティブなカタログの数を返します。

    表 : 9. パラメーター
    名前 タイプ 説明
    なし
    表 : 10. 返される内容
    タイプ 説明
    整数 カタログ表で使用可能なカタログの数

    例：

    console.log(sn_sc.Catalog.getCatalogCount());

    出力：

    3

    CatalogJS - getCategories()

    現在のカタログのカテゴリを返します。

    表 : 11. パラメーター
    名前 タイプ 説明
    なし
    表 : 12. 返される内容
    タイプ 説明
    ArrayList 現在のカタログのカテゴリを返します。

    この例は、現在のカタログオブジェクトで利用可能なカテゴリを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategories());

    出力：

    0 : {header_image: "", sys_id: "e15706fc0a0a0aa7007fc21e1ab70c2f", description: "Your IT gateway. Report issues and submit requests.", title: "Can We Help You?"} 
1 : {header_image: "", sys_id: "95fc11615f1211001c9b2572f2b477c6", description: "Services offered by different departments in the organization", title: "Departmental Services"} 
2 : {header_image: "", sys_id: "900682363731300054b6a3549dbe5d5f", description: "Desktop computers for your work area.", title: "Desktops"} 
3 : {header_image: "", sys_id: "d2f716fcc611227a015a142fa0b262c1", description: "Order new furniture, and fixtures, or request for cubicle modifications can also be ordered here.", title: "Furniture and Decor"} 
4 : {header_image: "", sys_id: "d258b953c611227a0146101fb1be7c31", description: "Order from a variety of hardware to meet your business needs, including phones, tablets and laptops.", title: "Hardware"}

    CatalogJS - getCategoryIds()

    現在のカタログ内のカテゴリの sys_id を指定します。

    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    ArrayList 現在のカタログ内のカテゴリの sys_id を返します。

    この例は、現在のカタログで利用可能なカテゴリの sys_id を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getCategoryIds());

    出力：

    0:"e15706fc0a0a0aa7007fc21e1ab70c2f"
1 : "95fc11615f1211001c9b2572f2b477c6"
2 : "900682363731300054b6a3549dbe5d5f"
3 : "d2f716fcc611227a015a142fa0b262c1"

    CatalogJS - getDescription()

    現在のカタログの記述を返します。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 返される内容
    タイプ 説明
    文字列 カタログの説明

    この例は、現在のカタログの名前を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDescription());

    出力：

    Service Catalog - IT Now

    CatalogJS - getDesktopImageSRC()

    カタログデスクトップ画像のファイル名を返します。

    表 : 17. パラメーター
    名前 タイプ 説明
    なし
    表 : 18. 返される内容
    タイプ 説明
    文字列 カタログデスクトップ画像のファイル名。

    この例は、現在のカタログデスクトップ画像のファイル名を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getDesktopImageSRC());

    出力：

    adbcc271475211002ee987e8dee49001.iix

    CatalogJS - getGr()

    現在のカタログの GlideRecord を返します。

    表 : 19. パラメーター
    名前 タイプ 説明
    なし
    表 : 20. 返される内容
    タイプ 説明
    GlideRecord 現在のカタログの GlideRecord。

    この例は、指定されたカタログの GlideRecord を返します。

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
data.history = catalog.getGr();

    CatalogJS - getHeaderIconSRC()

    現在のカタログのヘッダーアイコンを返します。

    表 : 21. パラメーター
    名前 タイプ 説明
    なし
    表 : 22. 返される内容
    タイプ 説明
    文字列 カタログ ヘッダー アイコン

    この例は、カタログのヘッダーアイコンの名前を取得する方法を示しています。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getHeaderIconSRC());

    出力：

    service_catalog_header.png

    CatalogJS - getID()

    現在のカタログの sys_id を返します。

    表 : 23. パラメーター
    名前 タイプ 説明
    なし
    表 : 24. 返される内容
    タイプ 説明
    文字列 現在のカタログの sys_id。

    この例は、現在のカタログの sys_id を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
console.log(catalog.getId());

    出力：

    e0d08b13c3330100c8b837659bba8fb4

    CatalogJS - getTitle()

    現在のカタログのタイトルを返します。

    表 : 25. パラメーター
    名前 タイプ 説明
    なし
    表 : 26. 返される内容
    タイプ 説明
    文字列 現在のカタログのタイトル。

    この例は、現在のカタログのタイトルを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.getTitle());

    出力：

    Service Catalog

    CatalogJS - hasCategories()

    現在のカタログにカテゴリが含まれているかどうかを指定します。

    表 : 27. パラメーター
    名前 タイプ 説明
    なし
    表 : 28. 返される内容
    タイプ 説明
    ブーリアン

    現在のカタログにカテゴリが含まれているかどうかを示すフラグ。

    有効な値：
    • true：カタログにカテゴリが含まれています。
    • false：カタログにカテゴリは含まれていません。

    この例は、現在のカタログにカテゴリが含まれているかどうかを判断する方法を示しています。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasCategories());

    出力：

    false

    CatalogJS - hasItems()

    現在のカタログにカタログアイテムが含まれているかどうかを指定します。

    表 : 29. パラメーター
    名前 タイプ 説明
    なし
    表 : 30. 返される内容
    タイプ 説明
    ブーリアン

    現在のカタログにカタログアイテムが含まれているかどうかを示すフラグ。

    有効な値：
    • true：カタログにカタログアイテムが含まれています。
    • false：カタログにカタログアイテムは含まれていません。

    例：

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.hasItems());

    出力：

    true

    CatalogJS - isWishlistEnabled()

    現在のカタログでウィッシュリストが有効になっているかどうかを指定します。

    表 : 31. パラメーター
    名前 タイプ 説明
    なし
    表 : 32. 返される内容
    タイプ 説明
    ブーリアン

    現在のカタログがウィッシュリストをサポートするかどうかを示すフラグ。

    有効な値：
    • true：カタログはウィッシュリストをサポートしています。
    • false：カタログはウィッシュリストをサポートしていません。

    この例は、現在のカタログでウィッシュリストが有効になっているかどうかを確認する方法を示しています。

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
gs.info(catalog.isWishlistEnabled());

    出力：

    true