CustomPageService

Custom Page service can be used in the following way:

1. Import the service from our library:

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

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

async getAllCustomPages() {
       return await CustomPageService.getAllCustomPages();
     }

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

async getASpecificCustomPage(customPageId) {
       return await CustomPageService.getASpecificCustomPage(customPageId);
    }

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 CustomPageService()

new CustomPageService(): CustomPageService

Returns

CustomPageService

Methods

getASpecificCustomPage()

static getASpecificCustomPage(id, config?): Promise<SCCustomPageType>

Parameters

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

Returns

Promise<SCCustomPageType>

Source

services/custom_page/index.ts:84

---

getAllCustomPages()

static getAllCustomPages(params?, config?): Promise <SCPaginatedResponse<SCCustomPageType>>

Parameters

Parameter	Type
params?	CustomPageParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomPageType>>

Source

services/custom_page/index.ts:87

---

searchCustomPages()

static searchCustomPages(params?, config?): Promise <SCPaginatedResponse<SCCustomPageType>>

Parameters

Parameter	Type
params?	CustomPageSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCustomPageType>>

Source

services/custom_page/index.ts:90