⚙️Settings

Fetch and edit your domain's settings

Get URL Settings

URL Settings determine which paths on your domain have their own whiteboard, and which ones simply use the main whiteboard.

const urlSettings = await proticoAPI.settings.get(domain:string);

Parameters description

Parameter	Description	Type
domain	Current domain	string

Get One URL Setting

You can fetch a single URL setting from the list, by using its ID.

const urlSettings = await proticoAPI.settings.getOne(urlSettingId:string);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting to be fetched	string

Add One URL Setting

Add a new setting for your domain, it will create a new whiteboard for the given url.

type UrlSettingItem={url:string};
const urlSettings = await proticoAPI.settings.addOne(domain:string,data:UrlSettingItem);

Parameters description

Parameter	Description	Type
domain	Current domain	string
data.url	URL to have its own whiteboard	string

Modify one URL Setting

You can also modify one of the current settings.

const urlSettings = await proticoAPI.settings.updateOne(urlSettingId:string,data:UrlSettingItem);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting to be fetched	string
data.url	URL to have its own whiteboard	string

Delete one URL Setting

To delete one url setting, do the following:

const urlSettings = await proticoAPI.settings.deleteOne(urlSettingId:string);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting to be fetched	string

Get Domain Settings

To get other domain settings, such as `use_separate_url`:

const otherSettings = await proticoAPI.settings.getDomainSettings(domain:string);

Parameters description

Parameter	Description	Type
domain	Current domain	string

a