1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-25 21:39:21 +02:00
Vitaly the Alpaca (bot) 5cc51552f4 Main build (Jenkins)
2024-11-21 22:39:27 +03:00

60 lines
1.2 KiB
Plaintext

---
sidebar_position: 9
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get comment structure
Get comment fields structure
`Function GetCommentStructure(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.GetCommentStructure();
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetCommentStructure \
--empty false
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetCommentStructure ^
--empty false
```
</TabItem>
</Tabs>
```json title="Result"
{
"AUTHOR_ID": "<comment author identifier>",
"AUTHOR_NAME": "<Users name (optional)>",
"AUTHOR_EMAIL": "<Users email (optional)>",
"USE_SMILES": "<(Y|N) - parse comments for emoticons or not>",
"POST_MESSAGE": "<Message text>",
"UF_FORUM_MESSAGE_DOC": "<Array of files from disk to attach>"
}
```