1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-29 22:27:42 +02:00

Main build (Jenkins)

This commit is contained in:
Vitaly the Alpaca (bot)
2025-03-16 21:02:16 +03:00
parent 8d86925aa7
commit c252bf1bb2
90 changed files with 8477 additions and 7098 deletions

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Create Connection
Opens a new RCON connection
`Function CreateConnection(Val ConnectionParams) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| ConnectionParams | - | Structure Of KeyAndValue | ✔ | Connection parameters. See FormConnectionParameters |
Returns: Arbitrary - Connector object or structure with error information
<br/>
:::caution
**NOCLI:** this method is not available in CLI version
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "127.0.0.1:25565";
Password = "Jg9F...";
WriteTimeout = 20;
ReadTimeout = 20;
ConnectionParams = OPI_RCON.FormConnectionParameters(URL, Password, ReadTimeout, WriteTimeout);
Result = OPI_RCON.CreateConnection(ConnectionParams);
```

View File

@@ -0,0 +1,48 @@
---
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Execute command
Executes the command on the server
`Function ExecuteCommand(Val Command, Val Connection) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Command | --exec | String | &#x2714; | Command text |
| Connection | --conn | Arbitrary, Structure Of KeyAndValue | &#x2714; | Connection or connection parameters |
Returns: Map Of KeyAndValue - Result of command execution
<br/>
:::tip
When passing connection parameters, a new connection will be created and closed within the execution of a single command. To execute several commands (in OS and 1C versions), it is recommended to use a connection created in advance (see CreateConnection)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "127.0.0.1:25565";
Password = "Jg9F...";
WriteTimeout = 20;
ReadTimeout = 20;
ConnectionParams = OPI_RCON.FormConnectionParameters(URL, Password, ReadTimeout, WriteTimeout);
Connection = OPI_RCON.CreateConnection(ConnectionParams);
Command = "list";
Result = OPI_RCON.ExecuteCommand(Command, Connection);
```

View File

@@ -0,0 +1,42 @@
---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Form connection parameters
Forms a collection of connection parameters
`Function FormConnectionParameters(Val URL, Val Password, Val ReadTimeout = 30, Val WriteTimeout = 30) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | &#x2714; | Server URL |
| Password | --pass | String | &#x2714; | Password for connection |
| ReadTimeout | --rtout | Number | &#x2716; | Response timeout (in seconds) |
| WriteTimeout | --wtout | Number | &#x2716; | Request sending timeout (in seconds) |
Returns: Structure Of KeyAndValue - Structure of connection parameters
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "127.0.0.1:25565";
Password = "Jg9F...";
WriteTimeout = 20;
ReadTimeout = 20;
Result = OPI_RCON.FormConnectionParameters(URL, Password, ReadTimeout, WriteTimeout);
```

View File

@@ -0,0 +1,39 @@
---
sidebar_position: 4
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Is connector
Checks that the value is an object of an RCON AddIn
`Function IsConnector(Val Value) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Value | - | Arbitrary | &#x2714; | Value to check |
Returns: Boolean - Is connector
<br/>
:::caution
**NOCLI:** this method is not available in CLI version
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
```

View File

@@ -0,0 +1,4 @@
{
"label": "Commands execution",
"position": "2"
}