Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Корректировка и дополнение документации метода socialnetwork.api.workgroup.get #1

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Корректировка и дополнение документации метода socialnetwork.api.workgroup.get #1

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
adb763e
Небольшое изменение socialnetwork.api.workgroup.get
jabir-sabitov Aug 20, 2024
56b8845
Описан параметр params метода socialnetwork.api.workgroup.get
jabir-sabitov Aug 20, 2024
1ffb084
Изменён тип параметра params "array" -> "object"
jabir-sabitov Aug 21, 2024
991862e
Дополнено описание ключа groupId параметра params
jabir-sabitov Aug 21, 2024
bad07ff
Удалён ненужный столбец "С версии"
jabir-sabitov Aug 21, 2024
8bb85b1
Изменено название столбца "Параметр" -> "Название"
jabir-sabitov Aug 21, 2024
c62ca65
Описан параметр mode параметра params
jabir-sabitov Aug 21, 2024
0b1646a
Обновлено описание socialnetwork.api.workgroup.get
jabir-sabitov Aug 22, 2024
d8149c1
Описан параметр select параметра params
jabir-sabitov Sep 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions api-reference/sonet-group/socialnetwork-api-workgroup-get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,24 @@

Метод возвращает данные по рабочей группе

## Параметры
## Параметры метода

{% include [Сноска об обязательных параметрах](../../_includes/required.md) %}

#|
|| **Параметр** | **Описание** | **С версии** ||
|| **groupId** | Идентификатор группы. Обязательный параметр, целое число. | ||
|| **Название** `тип` | **Описание** ||
|| **params*** [`object`](../data-types.md) | Параметры запроса для получения группы. ||
|#

{% include [Сноска о параметрах](../../_includes/required.md) %}
### Параметр `params`

{% include [Сноска об обязательных параметрах](../../_includes/required.md) %}

#|
|| **Название** `тип` | **Описание** ||
|| **groupId*** [`integer`](../data-types.md) | Идентификатор группы. Значение для поля может быть получено методом [sonet_group.get](./sonet-group-get.md). ||
|| **mode** [`string`](../data-types.md) | Режим запроса. Может принимать только значение `mobile`, с помощью которого можно получить дополнительные данные (см. ниже). ||
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Метод Bitrix\Socialnetwork\Controller\Workgroup::getAction, 223-226 строка:

    if (
                                isset($params['mode'])
                                && $params['mode'] === 'mobile'
                        )
                        {
                                $additionalData = Helper\Workgroup::getAdditionalData([
                                        'ids' => [ $groupId ],
                                        'features' => ($params['features'] ?? []),
                                        'mandatoryFeatures' => ($params['mandatoryFeatures'] ?? []),
                                        'currentUserId' => (int)$this->getCurrentUser()->getId(),
                                ]);

                                $groupFields['ADDITIONAL_DATA'] = ($additionalData[$groupId] ?? []) ;
                        }

|#

## Поля

Expand Down Expand Up @@ -92,4 +102,4 @@ BX24.callMethod('socialnetwork.api.workgroup.get', {
console.log(result);
});
```
{% include [Сноска о примерах](../../_includes/examples.md) %}
{% include [Сноска о примерах](../../_includes/examples.md) %}