getMenusByMarker

Modul 'Menus' mendefinisikan struktur dan navigasi situs Anda.

Deskripsi

Ini memberikan pengunjung cara yang mudah untuk berpindah melalui bagian-bagian aplikasi Anda dan menemukan informasi yang mereka butuhkan.

Metode ini mengambil satu objek menu berdasarkan penandanya (marker) dari API. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi satu objek menu IMenusEntity sebagai objek dengan halaman yang disertakan.

Menus.getMenusByMarker(

marker*, langCode

);

Skema parameter

Skema

marker(diperlukan): string
Penanda menu
contoh: "main_menu"

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

Contoh

Contoh minimal

const response = await Menus.getMenusByMarker('my-marker')

Contoh respons

{
  "id": 1,
  "identifier": "main_menu",
  "localizeInfos": {
    "title": "menu"
  },
  "pages": [
    {
      "id": 8,
      "pageUrl": "blog",
      "localizeInfos": {
        "title": "Blog",
        "menuTitle": "Blog",
        "htmlContent": "",
        "plainContent": ""
      },
      "attributeValues": {},
      "parentId": null,
      "parentType": null,
      "position": 1,
      "itemType": "page",
      "children": [
        {
          "id": 9,
          "pageUrl": "blog1",
          "localizeInfos": {
            "title": "Blog 1",
            "menuTitle": "Blog 1",
            "htmlContent": "",
            "plainContent": ""
          },
          "attributeValues": {},
          "parentId": 8,
          "parentType": "page",
          "position": 1,
          "itemType": "page",
          "children": []
        }
      ]
    },
    {
      "id": 10,
      "pageUrl": "catalog",
      "localizeInfos": {
        "title": "Catalog",
        "menuTitle": "Catalog",
        "htmlContent": "",
        "plainContent": ""
      },
      "attributeValues": {},
      "parentId": null,
      "parentType": null,
      "position": 2,
      "itemType": "page",
      "children": []
    }
  ]
}

Skema respons

Skema: IMenusEntity

id: number
Pengidentifikasi unik dari menu.
contoh: 1

identifier: string
Pengidentifikasi menu.
contoh: "main_menu"

localizeInfos: ILocalizeInfo
Berisi informasi lokalisasi.
contoh:

{
  "title": "menu"
}

pages: IMenusPages[]
Array halaman menu.
contoh:

[
  {
    "id": null,
    "pageUrl": null,
    "localizeInfos": {},
    "attributeValues": {},
    "parentId": null,
    "position": 1
  }
]

pages.children: IMenusPages[]
Berisi array dengan objek halaman anak.
contoh:

[
  {
    "id": null,
    "pageUrl": null,
    "localizeInfos": {},
    "attributeValues": {},
    "parentId": null,
    "position": 1
  }
]

pages.id: number | null
Pengidentifikasi unik dari menu.
contoh: 1

pages.pageUrl: string | null
String url halaman.
contoh: "about"

pages.localizeInfos: ILocalizeInfo
Data menu, dengan mempertimbangkan lokalisasi.
contoh:

{
  "title": "menu"
}

pages.attributeValues: IAttributeValues
Set atribut.
contoh:

{
  "color": "red",
  "size": "large"
}

pages.position: number
Posisi menu.
contoh: 1

pages.parentId: number | null
Id induk menu.
contoh: null

pages.parentType: 'page' | 'custom' | null
Jenis item induk: page untuk halaman menu, custom untuk item kustom; null bersama dengan parentId berarti tingkat atas. Id halaman dan id item kustom tumpang tindih, sehingga induk menjadi ambigu tanpa itu.
contoh: null

pages.itemType: 'page' | 'custom'
Jenis item itu sendiri: page atau custom. Ini adalah nilai yang harus dilalui anak item dalam parentType.
contoh: "page"

---