Skip to main content

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

Constructor

new CustomMenuService(): CustomMenuService

Returns

CustomMenuService

Methods

getAllCustomMenus()

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

Parameters

ParameterType
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomMenuType>>


getASpecificCustomMenu()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCCustomMenuType>


getBaseCustomMenu()

static getBaseCustomMenu(config?): Promise<SCCustomMenuType>

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<SCCustomMenuType>


searchCustomMenus()

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

Parameters

ParameterType
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCustomMenuType>>