You've already forked OpenIntegrations
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:
45
docs/en/md/RCON/Commands-execution/Create-connection.mdx
vendored
Normal file
45
docs/en/md/RCON/Commands-execution/Create-connection.mdx
vendored
Normal 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);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
48
docs/en/md/RCON/Commands-execution/Execute-command.mdx
vendored
Normal file
48
docs/en/md/RCON/Commands-execution/Execute-command.mdx
vendored
Normal 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 | ✔ | Command text |
|
||||
| Connection | --conn | Arbitrary, Structure Of KeyAndValue | ✔ | 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);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
42
docs/en/md/RCON/Commands-execution/Form-connection-parameters.mdx
vendored
Normal file
42
docs/en/md/RCON/Commands-execution/Form-connection-parameters.mdx
vendored
Normal 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 | ✔ | Server URL |
|
||||
| Password | --pass | String | ✔ | Password for connection |
|
||||
| ReadTimeout | --rtout | Number | ✖ | Response timeout (in seconds) |
|
||||
| WriteTimeout | --wtout | Number | ✖ | 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);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
39
docs/en/md/RCON/Commands-execution/Is-connector.mdx
vendored
Normal file
39
docs/en/md/RCON/Commands-execution/Is-connector.mdx
vendored
Normal 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 | ✔ | 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"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4
docs/en/md/RCON/Commands-execution/_category_.json
vendored
Normal file
4
docs/en/md/RCON/Commands-execution/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Commands execution",
|
||||
"position": "2"
|
||||
}
|
||||
Reference in New Issue
Block a user