1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-06-04 23:37:46 +02:00
OpenIntegrations/docs/en/md/Bitrix24/Calendars-management/Get-calednar-custom-settings-structure.mdx
Vitaly the Alpaca (bot) 186b4513b6 Main build (Jenkins)
2025-02-10 12:36:30 +03:00

83 lines
2.1 KiB
Plaintext
Vendored

---
sidebar_position: 9
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get calednar custom settings structure
Gets an empty structure for setting custom calendar settings
`Function GetCalednarCustomSettingsStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Clear | --empty | Boolean | ✖ | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure Of KeyAndValue - Fields structure
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Result = OPI_Bitrix24.GetCalednarCustomSettingsStructure();
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetCalednarCustomSettingsStructure \
--empty true
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetCalednarCustomSettingsStructure ^
--empty true
```
</TabItem>
</Tabs>
```json title="Result"
{
"view": "<standard presentation: day, week, month, list>",
"meetSection": "<invitation calendar>",
"crmSection": "<calendar for CRM>",
"showDeclined": "<show rejected events>",
"denyBusyInvitation": "<disallow invitations to an event if the time is full>",
"collapseOffHours": "<hide off hours: Y,N>",
"showWeekNumbers": "<show week number: Y,N>",
"showTasks": "<display tasks: Y,N>",
"syncTasks": "<synchronise the task calendar: Y,N>",
"showCompletedTasks": "<display completed tasks: Y,N>",
"lastUsedSection": "<default event calendar>",
"sendFromEmail": "<E-mail for sending invitations>",
"defaultSections": "<preset calendar settings>",
"syncPeriodPast": "<number of months to synchronise in the past period>",
"syncPeriodFuture": "<number of months to synchronise in the future period>",
"defaultReminders": {
"fullDay": [
{
"type": "<reminder time type: min, hour, day>",
"count": "<numeric value of the time interval>"
}
],
"withTime": [
{
"type": "<reminder time type: min, hour, day>",
"count": "<numeric value of the time interval>"
}
]
}
}
```