MenusModule
Provides methods to retrieve navigation menus.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MenusModule(
client):MenusModule
Parameters
Section titled “Parameters”client
Section titled “client”Returns
Section titled “Returns”MenusModule
Methods
Section titled “Methods”createMenu()
Section titled “createMenu()”createMenu(
data):Promise<{data:MenuItem;success:boolean; }>
Creates a new menu item.
Parameters
Section titled “Parameters”any
The menu item data.
Returns
Section titled “Returns”Promise<{ data: MenuItem; success: boolean; }>
deleteMenu()
Section titled “deleteMenu()”deleteMenu(
id):Promise<{success:boolean; }>
Deletes a menu item.
Parameters
Section titled “Parameters”string
The ID of the menu item.
Returns
Section titled “Returns”Promise<{ success: boolean; }>
getMenus()
Section titled “getMenus()”getMenus():
Promise<{data:MenuItem[]; }>
Retrieves the hierarchical list of navigation menus based on user permissions.
Returns
Section titled “Returns”Promise<{ data: MenuItem[]; }>
A promise resolving to an array of MenuItem trees.
reorderMenus()
Section titled “reorderMenus()”reorderMenus(
items):Promise<{success:boolean; }>
Batch reorder menus - updates parentId and position for multiple items at once.
Parameters
Section titled “Parameters”object[]
Array of {id, parentId, position}
Returns
Section titled “Returns”Promise<{ success: boolean; }>
updateMenu()
Section titled “updateMenu()”updateMenu(
id,data):Promise<{success:boolean; }>
Updates an existing menu item.
Parameters
Section titled “Parameters”string
The ID of the menu item.
any
The updated data.
Returns
Section titled “Returns”Promise<{ success: boolean; }>