CustomMenuService

Custom Menu service can be used in the following way:

1. Import the service from our library:

import {CustomMenuService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllCustomMenus` will return the paginated list of custom menus.

async getAllCustomMenus() {
       return await CustomMenuService.getAllCustomMenus();
     }

In case of required `params`, just add them inside the brackets.

async getASpecificCustomMenu(customMenuId) {
       return await CustomMenuService.getASpecificCustomMenu(customMenuId);
    }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new CustomMenuService()

new CustomMenuService(): CustomMenuService

Returns

CustomMenuService

Methods

getASpecificCustomMenu()

static getASpecificCustomMenu(id, config?): Promise<SCCustomMenuType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCustomMenuType>

Source

services/custom_menu/index.ts:93

---

getAllCustomMenus()

static getAllCustomMenus(params?, config?): Promise <SCPaginatedResponse<SCCustomMenuType>>

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomMenuType>>

Source

services/custom_menu/index.ts:96

---

getBaseCustomMenu()

static getBaseCustomMenu(config?): Promise<SCCustomMenuType>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCCustomMenuType>

Source

services/custom_menu/index.ts:99

---

searchCustomMenus()

static searchCustomMenus(params?, config?): Promise <SCPaginatedResponse<SCCustomMenuType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomMenuType>>

Source

services/custom_menu/index.ts:102