Interface IGroupService

Объект, управляющий группами.

interface IGroupService {
    getAllGroups(category?: null | string): Promise<IGroupInfo[]>;
    getGroup(groupID: string): Promise<null | IGroupGetResponse>;
    storeGroup(request: IGroupStoreRequest): Promise<void>;
}

Implemented by

GroupService

Index

Methods

getAllGroups getGroup storeGroup

Methods

getAllGroups

getAllGroups(category?: null | string): Promise<IGroupInfo[]>
Загружает список всех доступных групп с базовой информацией по ним (без состава и списка администраторов).
Parameters
- Optionalcategory: null | string
  Путь к категории, в которой располагается группа. В качестве разделителя категорий в пути используется символ /.
Returns Promise<IGroupInfo[]>
Список доступных групп.
- Defined in @tessa/platform/src/groups/groupTypes.ts:317

getGroup

getGroup(groupID: string): Promise<null | IGroupGetResponse>
Загружает информацию по указанной группе.
Parameters
- groupID: string
  Идентификатор группы.
Returns Promise<null | IGroupGetResponse>
Информация по указанной группе или null, если группа отсутствует.
- Defined in @tessa/platform/src/groups/groupTypes.ts:324

storeGroup

storeGroup(request: IGroupStoreRequest): Promise<void>
Сохраняет группу с изменением её параметров.
Parameters
- request: IGroupStoreRequest
  Запрос на сохранение группы.
Returns Promise<void>
- Defined in @tessa/platform/src/groups/groupTypes.ts:330