---
url: https://docs.juniper.bot/message-templates/types/custom-commands/arguments.md
description: Тип данных Arguments, используемый в пользовательских командах JuniperBot.
---

[Число]: /message-templates/types/index#literals

[Строка]: /message-templates/types/index#literals

[Логический]: /message-templates/types/index#literals

[Список]: /message-templates/types/index#lists

[Карта]: /message-templates/types/index#maps

[DateTime]: /message-templates/types/index#datetime

[TwitchChannel]: /message-templates/types/subscriptions/twitch#twitch-channel

[TwitchStream]: /message-templates/types/subscriptions/twitch#twitch-stream

[TwitchGame]: /message-templates/types/subscriptions/twitch#twitch-game

[YouTubeChannel]: /message-templates/types/subscriptions/youtube#youtube-channel

[YouTubeVideo]: /message-templates/types/subscriptions/youtube#youtube-video

[VkWallPost]: /message-templates/types/subscriptions/vk#vkwallpost

[Rank]: /message-templates/types/discord/rank

[Guild]: /message-templates/types/discord/guild

[Member]: /message-templates/types/discord/member

[Role]: /message-templates/types/discord/role

[Message]: /message-templates/types/discord/message

[Attachment]: /message-templates/types/discord/attachment

[Embed]: /message-templates/types/discord/embed

[Activity]: /message-templates/types/discord/activity

[MemberVoiceState]: /message-templates/types/discord/member-voice-state

[MemberPrimaryGuild]: /message-templates/types/discord/member-primary-guild

[MenuBuilder]: /message-templates/types/discord/menu-builder

[UserFlag]: /message-templates/types/discord/user-flag

[Permission]: /message-templates/types/discord/permission

[Category]: /message-templates/types/discord/category

[TextChannel]: /message-templates/types/discord/text-channel

[VoiceChannel]: /message-templates/types/discord/voice-channel

[NewsChannel]: /message-templates/types/discord/news-channel

[StageChannel]: /message-templates/types/discord/stage-channel

[ForumChannel]: /message-templates/types/discord/forum-channel

[MediaChannel]: /message-templates/types/discord/media-channel

[ThreadChannel]: /message-templates/types/discord/thread-channel

[Page]: /message-templates/types/storage/page

[GuildIndex]: /message-templates/types/storage/guild-index

[GuildIndexEntry]: /message-templates/types/storage/guild-index-entry

[GuildIndexes]: /message-templates/types/storage/guild-indexes

[MemberAttribute]: /message-templates/types/storage/member-attribute

[MemberAttributes]: /message-templates/types/storage/member-attributes

[Arguments]: /message-templates/types/custom-commands/arguments

[Parameters]: /message-templates/types/custom-commands/parameters

[Component]: /message-templates/types/custom-commands/component

[Modal]: /message-templates/types/custom-commands/modal

# Arguments

Этот тип данных описывает аргументы вызова [пользовательской команды](../../../cmd/custom/index).

## Свойства { #properties }

| Свойство       | Тип                | Описание                                                                                                                                                                                                                                                                                                                                        |
|:---------------|:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `value`        | \[Строка]           | Исходная строка вызова пользовательской команды                                                                                                                                                                                                                                                                                                 |
| `args`         | \[Список]<\[Строка]> | Список аргументов, извлеченных из строки и разделенных пробелом                                                                                                                                                                                                                                                                                 |
| `targetMember` | \[Member]           | При вызове текстовой командой — первый упомянутый участник или участник с id, указанным первым аргументом;При вызове контекстным меню участника — владелец меню;При вызове контекстным меню сообщения — автор этого сообщения;При вызове слэш-командой — указанный участник в любом из параметров. |

## Методы { #methods }

### `get(Номер)`  { #method-get .template-method }

::: tabs

\== Описание | mdi-text

Получение аргумента по указанному номеру.

**Возвращаемые типы:** \[Строка]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание                                |
|:---------|:--------|:----------------------------------------|
| `Номер`  | \[Число] | Номер аргумента (отсчет начинается с 1) |

\== Пример | mdi-code-block-braces

```template
{{ arguments.get(1) }}
```

:::

### `after(Номер)`  { #method-after .template-method }

::: tabs

\== Описание | mdi-text

Получение всех аргументов, начиная с указанного номера включительно.

**Возвращаемые типы:** \[Строка]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание                                |
|:---------|:--------|:----------------------------------------|
| `Номер`  | \[Число] | Номер аргумента (отсчет начинается с 1) |

\== Пример | mdi-code-block-braces

```template
{{ arguments.after(2) }}
```

:::

### `before(Номер)`  { #method-before .template-method }

::: tabs

\== Описание | mdi-text

Получение всех аргументов от первого до указанного включительно.

**Возвращаемые типы:** \[Строка]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание                                |
|:---------|:--------|:----------------------------------------|
| `Номер`  | \[Число] | Номер аргумента (отсчет начинается с 1) |

\== Пример | mdi-code-block-braces

```template
{{ arguments.before(3) }}
```

:::

### `range(Начало, Конец)`  { #method-range .template-method }

::: tabs

\== Описание | mdi-text

Получение диапазона аргументов.

**Возвращаемые типы:** \[Строка]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание           |
|:---------|:--------|:-------------------|
| `Начало` | \[Число] | Начало диапазона \* |
| `Конец`  | \[Число] | Конец диапазона \*  |

\* Отсчёт номеров аргументов начинается с 1.

\== Пример | mdi-code-block-braces

```template
{{ arguments.range(1, 5) }}
```

:::

### `getOption(Название)`  { #method-getoption .template-method }

::: tabs

\== Описание | mdi-text

Получение параметра слэш-команды по названию.

**Возвращаемые типы:** \[Строка], \[Число], \[Логический], \[Member], \[Role], \[Attachment], \[TextChannel], \[NewsChannel], \[VoiceChannel], \[StageChannel], \[ForumChannel], \[MediaChannel], \[ThreadChannel], \[Category]

\== Параметры | mdi-code-parentheses

| Параметр   | Тип      | Описание           |
|:-----------|:---------|:-------------------|
| `Название` | \[Строка] | Название параметра |

\== Пример | mdi-code-block-braces

```template
{{ arguments.getOption('optionName') }}
```

:::

### `getOptionsByType(Тип)`  { #method-getoptionsbytype .template-method }

::: tabs

\== Описание | mdi-text

Получение списка параметров слэш-команды по их типу.

**Возвращаемые типы:** \[Список] значений \[Строка], \[Число], \[Логический], \[Member], \[Role], \[Attachment], \[TextChannel], \[NewsChannel], \[VoiceChannel], \[StageChannel], \[ForumChannel], \[MediaChannel], \[ThreadChannel], \[Category]

\== Параметры | mdi-code-parentheses

| Параметр | Тип      | Описание                                                                                                            |
|:---------|:---------|:--------------------------------------------------------------------------------------------------------------------|
| `Тип`    | \[Строка] | Тип параметра (`STRING`, `INTEGER`, `DECIMAL`, `BOOLEAN`, `MEMBER`, `ROLE`, `CHANNEL`, `MENTIONABLE`, `ATTACHMENT`) |

\== Пример | mdi-code-block-braces

```template
{{ arguments.getOptionsByType('MEMBER') }}
```

:::