1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-06 08:49:29 +02:00

Правки доков

This commit is contained in:
Anton Titovets
2024-07-10 13:58:29 +03:00
parent 99d11bd36b
commit 8bd11cfb5a
683 changed files with 2837 additions and 2052 deletions

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Generates a block with an image to add to the message block array
<br/>
*Function GenerateImageBlock(Val URL, Val AlternateText = "") Export*
`Function GenerateImageBlock(Val URL, Val AlternateText = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Image block
```bsl title="Code example"
Text = "Alpaca picture";

View File

@@ -6,12 +6,10 @@ sidebar_position: 4
Archives an active channel
<br/>
*Function ArchiveChannel(Val Token, Val Channel) Export*
`Function ArchiveChannel(Val Token, Val Channel) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"

View File

@@ -6,12 +6,10 @@ sidebar_position: 3
Creates a new channel
<br/>
*Function CreateChannel(Val Token, Val Name, Val Private = False) Export*
`Function CreateChannel(Val Token, Val Name, Val Private = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Name = "testcov" + String(New UUID);

View File

@@ -6,12 +6,10 @@ sidebar_position: 6
Gets information about channel events
<br/>
*Function GetChannelHistory(Val Token, Val Channel) Export*
`Function GetChannelHistory(Val Token, Val Channel) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 6
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Gets a list of available channels
<br/>
*Function GetChannelList(Val Token, Val ExcludeArchived = False, Val Cursor = "") Export*
`Function GetChannelList(Val Token, Val ExcludeArchived = False, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
ExcludeArchived = True;

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Gets a list of users in the specified channel
<br/>
*Function GetChannelUserList(Val Token, Val Channel, Val Cursor = "") Export*
`Function GetChannelUserList(Val Token, Val Channel, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 5
Gets information about the channel
<br/>
*Function GetChannel(Val Token, Val Channel) Export*
`Function GetChannel(Val Token, Val Channel) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 7
Adds specified users to the channel
<br/>
*Function InviteUsersToChannel(Val Token, Val Channel, Val ArrayOfUsers) Export*
`Function InviteUsersToChannel(Val Token, Val Channel, Val ArrayOfUsers) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 7
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 9
Adds the current bot to the channel
<br/>
*Function JoinChannel(Val Token, Val Channel) Export*
`Function JoinChannel(Val Token, Val Channel) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 9
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 8
Removes specified user from channel
<br/>
*Function KickUserFromChannel(Val Token, Val Channel, Val User) Export*
`Function KickUserFromChannel(Val Token, Val Channel, Val User) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 8
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
User = "U06UG1CAYH2";

View File

@@ -6,12 +6,10 @@ sidebar_position: 10
Removes the current bot from the channel
<br/>
*Function LeaveChannel(Val Token, Val Channel) Export*
`Function LeaveChannel(Val Token, Val Channel) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 10
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 13
Changes the name of the channel
<br/>
*Function RenameChannel(Val Token, Val Channel, Val Name) Export*
`Function RenameChannel(Val Token, Val Channel, Val Name) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 13
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Name = "testcov" + String(New UUID);

View File

@@ -6,12 +6,10 @@ sidebar_position: 12
Sets the channel purpose (description)
<br/>
*Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export*
`Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 12
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Purpose = "TestGoal";

View File

@@ -6,12 +6,10 @@ sidebar_position: 11
Sets the channel topic
<br/>
*Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export*
`Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 11
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Closes an existing dialog
<br/>
*Function CloseDialog(Val Token, Val Dialog) Export*
`Function CloseDialog(Val Token, Val Dialog) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Dialog = "D06UAKK1C6R";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Opens a new dialog with one or more users
<br/>
*Function OpenDialog(Val Token, Val ArrayOfUsers) Export*
`Function OpenDialog(Val Token, Val ArrayOfUsers) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
ArrayOfUsers = New Array;

View File

@@ -6,12 +6,10 @@ sidebar_position: 3
Adds a new external file
<br/>
*Function AddExternalFile(Val Token, Val URL, Val Title) Export*
`Function AddExternalFile(Val Token, Val URL, Val Title) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
URL = https://opi.neocities.org/test_data/document.docx;

View File

@@ -6,12 +6,10 @@ sidebar_position: 5
Deletes an external file from Slack
<br/>
*Function DeleteExternalFile(Val Token, Val FileID) Export*
`Function DeleteExternalFile(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
FileID = "F070P52CU94";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Gets a list of external files of a user or channel
<br/>
*Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export*
`Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Gets information about the external file
<br/>
*Function GetExternalFile(Val Token, Val FileID) Export*
`Function GetExternalFile(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
FileID = "F070P52CU94";

View File

@@ -6,12 +6,10 @@ sidebar_position: 4
Sends an external file to a list of channels
<br/>
*Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export*
`Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 4
Deletes a file on Slack
<br/>
*Function DeleteFile(Val Token, Val FileID) Export*
`Function DeleteFile(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
FileID = "F070VL6FQFM";

View File

@@ -6,12 +6,10 @@ sidebar_position: 3
Gets information about the file
<br/>
*Function GetFileData(Val Token, Val FileID) Export*
`Function GetFileData(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
FileID = "F070VL6FQFM";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Gets a list of files of the bot or channel
<br/>
*Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export*
`Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
PageNumber = 1;

View File

@@ -6,12 +6,10 @@ sidebar_position: 6
Removes the public URL from the file. Requires user token
<br/>
*Function MakeFilePrivate(Val Token, Val FileID) Export*
`Function MakeFilePrivate(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 6
Returns: Map Of KeyAndValue - Serialized JSON response from Slack

View File

@@ -6,12 +6,10 @@ sidebar_position: 5
Creates a public URL for the file. Requires user token
<br/>
*Function MakeFilePublic(Val Token, Val FileID) Export*
`Function MakeFilePublic(Val Token, Val FileID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - Serialized JSON response from Slack

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Uploads a file to Slack servers
<br/>
*Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export*
`Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -25,6 +23,9 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
FileName = "megadoc.docx";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Gets basic information about the bot
<br/>
*Function GetBotInformation(Val Token) Export*
`Function GetBotInformation(Val Token) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -21,6 +19,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"

View File

@@ -6,12 +6,10 @@ sidebar_position: 3
Gets a list of users in the workspace
<br/>
*Function GetUserList(Val Token, Val Cursor = "") Export*
`Function GetUserList(Val Token, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Gets a list of workspaces where the bot is connected
<br/>
*Function GetWorkspaceList(Val Token, Val Cursor = "") Export*
`Function GetWorkspaceList(Val Token, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -22,6 +20,9 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"

View File

@@ -6,12 +6,10 @@ sidebar_position: 4
Deletes a channel message by timestamp
<br/>
*Function DeleteMessage(Val Token, Val Channel, Val Timestamp, Val IsDelayed = False) Export*
`Function DeleteMessage(Val Token, Val Channel, Val Timestamp, Val IsDelayed = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -24,6 +22,9 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C06UFNUTKUL";

View File

@@ -6,12 +6,10 @@ sidebar_position: 3
Edits the content of an existing message
<br/>
*Function EditMessage(Val Token, Val Channel, Val Timestamp, Val Text = "", Val BlockArray = "") Export*
`Function EditMessage(Val Token, Val Channel, Val Timestamp, Val Text = "", Val BlockArray = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -25,6 +23,9 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 5
Gets a list of delayed channel messages
<br/>
*Function GetDelayedMessageList(Val Token, Val Channel, Val Cursor = "") Export*
`Function GetDelayedMessageList(Val Token, Val Channel, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 6
Gets a permanent URL to the channel message
<br/>
*Function GetMessageLink(Val Token, Val Channel, Val Timestamp) Export*
`Function GetMessageLink(Val Token, Val Channel, Val Timestamp) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -23,6 +21,9 @@ sidebar_position: 6
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 7
Gets an array of messages that are replies to the specified
<br/>
*Function GetMessageReplyList(Val Token, Val Channel, Val Timestamp, Val Cursor = "") Export*
`Function GetMessageReplyList(Val Token, Val Channel, Val Timestamp, Val Cursor = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -24,6 +22,9 @@ sidebar_position: 7
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 2
Sends a message that arrives in the channel but is visible only to a specific user
<br/>
*Function SendEphemeralMessage(Val Token, Val Channel, Val Text = "", Val User = "", Val Blocks = "") Export*
`Function SendEphemeralMessage(Val Token, Val Channel, Val Text = "", Val User = "", Val Blocks = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -25,6 +23,9 @@ Sends a message that arrives in the channel but is visible only to a specific us
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";

View File

@@ -6,12 +6,10 @@ sidebar_position: 1
Sends a message at a selected hour
<br/>
*Function SendMessage(Val Token, Val Channel, Val Text = "", Val SendingDate = "", Val Blocks = "") Export*
`Function SendMessage(Val Token, Val Channel, Val Text = "", Val SendingDate = "", Val Blocks = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@@ -25,6 +23,9 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example"
Channel = "C070VPMKN8J";