Class: CustomMenuService
services/custom_menu.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
Methods
getASpecificCustomMenu
▸ getASpecificCustomMenu(id, config?): Promise<SCCustomMenuType>
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomMenuType>
Defined in
services/custom_menu/index.ts:93
getAllCustomMenus
▸ getAllCustomMenus(params?, config?): Promise<SCPaginatedResponse<SCCustomMenuType>>
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomMenuType>>
Defined in
services/custom_menu/index.ts:96
getBaseCustomMenu
▸ getBaseCustomMenu(config?): Promise<SCCustomMenuType>
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCCustomMenuType>
Defined in
services/custom_menu/index.ts:99
searchCustomMenus
▸ searchCustomMenus(params?, config?): Promise<SCPaginatedResponse<SCCustomMenuType>>
Parameters
| Name | Type |
|---|---|
params? | BaseSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCustomMenuType>>