Interface IForumService

Объект, предоставляющий средства для получения объектов форумов с сервера и отправки с клиента на сервер.

Hierarchy

IForumService

Implemented by

ForumService

Index

Methods

addParticipants addRoles addTopic archiveTopic checkPermissionByFile getMessages getTopic getTopicsWithMessages removeParticipants removeRoles sendMessage setForumSettings subscribe updateMessage updateParticipants updateRoles

Methods

addParticipants

addParticipants(topicId: string, participants: string[], isReadOnly: boolean, type?: ForumParticipantType, isSubscribed?: boolean): Promise<[ForumResponse, ValidationResult]>
Добавляет участников в топик.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в который добавляются участники.
- participants: string[]
  
  Идентификаторы сотрудников, которые добавляются как участники.
- isReadOnly: boolean
  
  Признак того, что у участника доступ только для чтения.
- Optional type: ForumParticipantType
  
  Тип добавляемого участника.
- Optional isSubscribed: boolean
  
  Признак того, что участник подписан на уведомления.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:125

addRoles

addRoles(topicId: string, roles: string[], isReadOnly: boolean, isSubscribed?: boolean): Promise<ValidationResult>
Добавляет роли участников в топик.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в который добавляются роли участников.
- roles: string[]
  
  Идентификаторы ролей, добавляемых в топик. Сотрудники, входящие в эти роли, имеют доступ как участники топика.
- isReadOnly: boolean
  
  Признак того, что у участников роли доступ только для чтения.
- Optional isSubscribed: boolean
  
  Признак того, что участники роли подписаны.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:169

addTopic

addTopic(cardId: string, topic: ForumTopicModel): Promise<[ForumResponse, ValidationResult]>
Создаёт топик.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- cardId: string
  
  Идентификатор карточки, в которой создаётся топик.
- topic: ForumTopicModel
  
  Объект, содержащий информацию по создаваемому топику.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:86

archiveTopic

archiveTopic(topicId: string, isArchived?: boolean): Promise<ValidationResult>
Выполняет архивирование или разархивирование топика.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, для которого выполняется действие.
- Optional isArchived: boolean
  
  true, если выполняется архивирование топика; false, если выполняется разархивирование топика.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:224

checkPermissionByFile

checkPermissionByFile(fileId: string, isSuperModeratorModeEnabled: boolean): Promise<ValidationResult>
Проверяет возможность загрузить файл у пользователя в сессии.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- fileId: string
  
  Идентификатор файла, приложенного к одному из сообщений в топике.
- isSuperModeratorModeEnabled: boolean
  
  Признак того, что включён режим супермодератора.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:213

getMessages

getMessages(topicId: string, isSuperModeratorModeEnabled: boolean, messagesCount: number, pageNumber?: number, messageId?: null | string, lastReadMessageTime?: null | string, isNeedUpdateLastReadMessageTime?: boolean, searchText?: null | string, reverseOrder?: boolean): Promise<[ForumResponse, ValidationResult]>
Загружает сообщения топика.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, для которого загружаются сообщения.
- isSuperModeratorModeEnabled: boolean
  
  Признак того, что включён режим супермодератора.
- messagesCount: number
  
  Количество загружаемых сообщений.
- Optional pageNumber: number
  
  Номер загружаемой страницы. -1, если загружаются сообщения из последней страницы. Если задан параметр lastReadMessageTime, то загружается страница с указанным сообщением.
- Optional messageId: null | string
  
  Идентификатор сообщения, которое необходимо загрузить вместе со страницей данных, или null, если страница с сообщениями загружается по порядку, без учёта конкретных сообщений.
- Optional lastReadMessageTime: null | string
  
  Дата последнего прочитанного сообщения, страницу которого требуется открыть.
- Optional isNeedUpdateLastReadMessageTime: boolean
  
  Признак того, что требуется обновить дату/время последнего прочитанного сообщения для текущего пользователя.
- Optional searchText: null | string
  
  Строка с искомым текстом, если возвращается страница с результатами поиска, или null/пустая строка, если возвращается страница c сообщениями топика без выполняемого поиска по тексту.
- Optional reverseOrder: boolean
  
  Признак того, что сообщения загружаются в обратном порядке, от самого нового к самому старому.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:104

getTopic

getTopic(id: string, isSuperModeratorModeEnabled: boolean, permissionsToken?: null | IStorage<unknown>, singletonMode?: boolean, topicTypeId?: null | string): Promise<[ForumResponse, ValidationResult]>
Возвращает информацию по указанному топику.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- id: string
  
  Идентификатор запрашиваемого топика, если параметр singletonMode равен false, или идентификатор карточки, если параметр равен true, т.е. элемент управления находится в режиме "Единственное обсуждение".
- isSuperModeratorModeEnabled: boolean
  
  Признак того, что включён режим супермодератора.
- Optional permissionsToken: null | IStorage<unknown>
  
  Токен прав доступа.
- Optional singletonMode: boolean
  
  Признак того, что запрос выполняется для элемента управления в режиме "Единственное обсуждение".
- Optional topicTypeId: null | string
  
  Идентификатор типа, топики которого загружаются, или null, если загружаются любые топики.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:42

getTopicsWithMessages

getTopicsWithMessages(cardId: string, isSuperModeratorModeEnabled: boolean, messagesInTopicCount: number, lastDate: string, topicTypeId?: null | string): Promise<[ForumResponse, ValidationResult]>
Возвращает список топиков с последними сообщениями в каждом из них.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- cardId: string
  
  Идентификатор карточки, в которой ведутся обсуждения.
- isSuperModeratorModeEnabled: boolean
  
  Признак того, что включён режим супермодератора.
- messagesInTopicCount: number
  
  Максимальное количество последних сообщений, загружаемых с каждым топиком.
- lastDate: string
  
  Дата отправки самого старого сообщения, после которой сообщения с топиком не загружаются.
- Optional topicTypeId: null | string
  
  Идентификатор типа, топики которого загружаются, или null, если загружаются любые топики.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:24

removeParticipants

removeParticipants(topicId: string, participants: string[]): Promise<[ForumResponse, ValidationResult]>
Удаляет участников топика.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, участники в котором удаляются.
- participants: string[]
  
  Идентификаторы сотрудников, удаляемых из списка участников топика.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:156

removeRoles

removeRoles(topicId: string, roles: string[]): Promise<[ForumResponse, ValidationResult]>
Удаляет роли участников из топика.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, из которого удаляются роли участников.
- roles: string[]
  
  Идентификаторы ролей, удаляемые из списка участников топика.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:197

sendMessage

sendMessage(topicId: string, message: ForumMessageModel, isSuperModeratorModeEnabled: boolean, fileContentResolver?: null | FileContentResolver): Promise<[ForumResponse, ValidationResult]>
Отправляет сообщение в топике.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в котором отправляется сообщение.
- message: ForumMessageModel
  
  Объект, содержащий информацию по отправляемому сообщению.
- isSuperModeratorModeEnabled: boolean
  
  Признак того, что включён режим супермодератора.
- Optional fileContentResolver: null | FileContentResolver
  
  Функция для получения информации по контенту файлов, содержащихся в сообщении.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:58

setForumSettings

setForumSettings(settings: ForumSettingsModel): Promise<ValidationResult>
Сохраняет глобальные настройки топика.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- settings: ForumSettingsModel
  
  Объект, содержащий сохраняемые настройки.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:231

subscribe(topicId: string, isSubscribed?: boolean): Promise<ValidationResult>
Подписывает или отписывает текущего сотрудника как участника топика.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, для которого выполняется подписка или отписка.
- Optional isSubscribed: boolean
  
  true, если выполняется подписка на уведомления от топика; false, если выполняется отписка.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:205

updateMessage

updateMessage(topicId: string, message: ForumMessageModel, canEditAllMessages: boolean, fileContentResolver?: null | FileContentResolver): Promise<[ForumResponse, ValidationResult]>
Редактирует ранее отправленное сообщение.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в котором редактируется сообщение.
- message: ForumMessageModel
  
  Объект, содержащий информацию по отредактированному сообщению.
- canEditAllMessages: boolean
  
  Признак того, что пользователь имеет права на редактирование всех сообщений.
- Optional fileContentResolver: null | FileContentResolver
  
  Функция для получения информации по контенту файлов, содержащихся в сообщении.
Returns Promise<[ForumResponse, ValidationResult]>
- Defined in @tessa/platform/src/forums/forumTypes.ts:73

updateParticipants

updateParticipants(topicId: string, participants: string[], isReadOnly?: null | boolean, type?: null | ForumParticipantType, isSubscribed?: null | boolean): Promise<ValidationResult>
Изменяет свойства участников в топике.

Returns
ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в котором изменяются участники.
- participants: string[]
  
  Идентификаторы изменяемых сотрудников.
- Optional isReadOnly: null | boolean
  
  Признак того, что у участника доступ только для чтения, или null, если доступ не изменяется.
- Optional type: null | ForumParticipantType
  
  Тип участника, на который выполняется изменение, или null, если тип участника не изменяется.
- Optional isSubscribed: null | boolean
  
  Признак того, что участник подписан на уведомления, или null, если состояние подписки не изменяется.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:142

updateRoles

updateRoles(topicId: string, roles: string[], isReadOnly?: boolean, isSubscribed?: boolean): Promise<ValidationResult>
Изменяет роли участников в топике.

Returns
ValidationResult, содержащий информацию по возникшим ошибкам.
Parameters
- topicId: string
  
  Идентификатор топика, в котором изменяются роли участников.
- roles: string[]
  
  Идентификаторы ролей, изменяемых в топике. Сотрудники, входящие в эти роли, имеют доступ как участники топика.
- Optional isReadOnly: boolean
  
  Признак того, что у участников роли доступ только для чтения, или null, если доступ не изменяется.
- Optional isSubscribed: boolean
  
  Признак того, что участники роли подписаны, или null, если состояние подписки не изменяется.
Returns Promise<ValidationResult>
- Defined in @tessa/platform/src/forums/forumTypes.ts:184

Interface IForumService

Hierarchy

Implemented by

Index

Methods

Methods

addParticipants

Returns

Parameters

topicId: string

participants: string[]

isReadOnly: boolean

Optional type: ForumParticipantType

Optional isSubscribed: boolean

Returns Promise<[ForumResponse, ValidationResult]>

addRoles

Returns

Parameters

topicId: string

roles: string[]

isReadOnly: boolean

Optional isSubscribed: boolean

Returns Promise<ValidationResult>

addTopic

Returns

Parameters

cardId: string

topic: ForumTopicModel

Returns Promise<[ForumResponse, ValidationResult]>

archiveTopic

Returns

Parameters

topicId: string

Optional isArchived: boolean

Returns Promise<ValidationResult>

checkPermissionByFile

Returns

Parameters

fileId: string

isSuperModeratorModeEnabled: boolean

Returns Promise<ValidationResult>

getMessages

Returns

Parameters

topicId: string

isSuperModeratorModeEnabled: boolean

messagesCount: number

Optional pageNumber: number

Optional messageId: null | string

Optional lastReadMessageTime: null | string

Optional isNeedUpdateLastReadMessageTime: boolean

Optional searchText: null | string

Optional reverseOrder: boolean

Returns Promise<[ForumResponse, ValidationResult]>

getTopic

Returns

Parameters

id: string

isSuperModeratorModeEnabled: boolean

Optional permissionsToken: null | IStorage<unknown>

Optional singletonMode: boolean

Optional topicTypeId: null | string

Returns Promise<[ForumResponse, ValidationResult]>

getTopicsWithMessages

Returns

Parameters

cardId: string

isSuperModeratorModeEnabled: boolean

messagesInTopicCount: number

lastDate: string

Optional topicTypeId: null | string

Returns Promise<[ForumResponse, ValidationResult]>

removeParticipants

Returns

Parameters

topicId: string

participants: string[]

Returns Promise<[ForumResponse, ValidationResult]>

removeRoles

Returns

`Optional` type: ForumParticipantType

`Optional` isSubscribed: boolean

`Optional` isSubscribed: boolean

`Optional` isArchived: boolean

`Optional` pageNumber: number

`Optional` messageId: null | string

`Optional` lastReadMessageTime: null | string

`Optional` isNeedUpdateLastReadMessageTime: boolean

`Optional` searchText: null | string

`Optional` reverseOrder: boolean

`Optional` permissionsToken: null | IStorage<unknown>

`Optional` singletonMode: boolean

`Optional` topicTypeId: null | string

`Optional` topicTypeId: null | string

`Optional` fileContentResolver: null | FileContentResolver

`Optional` isSubscribed: boolean

`Optional` fileContentResolver: null | FileContentResolver

`Optional` isReadOnly: null | boolean

`Optional` type: null | ForumParticipantType

`Optional` isSubscribed: null | boolean

`Optional` isReadOnly: boolean

`Optional` isSubscribed: boolean