Class ForumService

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

Hierarchy

ForumService

Implements

IForumService

Index

Constructors

constructor

Methods

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

Constructors

constructor

new ForumService(_cardService: ICardService, _attachmentSaver: IForumAttachmentSaver): ForumService
Parameters
- _cardService: ICardService
- _attachmentSaver: IForumAttachmentSaver
Returns ForumService
- Defined in @tessa/platform/src/forums/forumService.ts:28

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
  
  Признак того, что у участника доступ только для чтения.
- type: ForumParticipantType = ForumParticipantType.Participant
  
  Тип добавляемого участника.
- isSubscribed: boolean = false
  
  Признак того, что участник подписан на уведомления.
Returns Promise<[ForumResponse, ValidationResult]>
Implementation of IForumService.addParticipants
- Defined in @tessa/platform/src/forums/forumService.ts:224

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>
Implementation of IForumService.addRoles
- Defined in @tessa/platform/src/forums/forumService.ts:280

addTopic

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

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

archiveTopic

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

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

checkPermissionByFile

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

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

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
  
  Количество загружаемых сообщений.
- pageNumber: number = -1
  
  Номер загружаемой страницы. -1, если загружаются сообщения из последней страницы. Если задан параметр lastReadMessageTime, то загружается страница с указанным сообщением.
- messageId: null | string = null
  
  Идентификатор сообщения, которое необходимо загрузить вместе со страницей данных, или null, если страница с сообщениями загружается по порядку, без учёта конкретных сообщений.
- lastReadMessageTime: null | string = null
  
  Дата последнего прочитанного сообщения, страницу которого требуется открыть.
- isNeedUpdateLastReadMessageTime: boolean = true
  
  Признак того, что требуется обновить дату/время последнего прочитанного сообщения для текущего пользователя.
- searchText: null | string = null
  
  Строка с искомым текстом, если возвращается страница с результатами поиска, или null/пустая строка, если возвращается страница c сообщениями топика без выполняемого поиска по тексту.
- reverseOrder: boolean = false
  
  Признак того, что сообщения загружаются в обратном порядке, от самого нового к самому старому.
Returns Promise<[ForumResponse, ValidationResult]>
Implementation of IForumService.getMessages
- Defined in @tessa/platform/src/forums/forumService.ts:186

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]>
Implementation of IForumService.getTopic
- Defined in @tessa/platform/src/forums/forumService.ts:58

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]>
Implementation of IForumService.getTopicsWithMessages
- Defined in @tessa/platform/src/forums/forumService.ts:37

removeParticipants

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

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

removeRoles

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

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

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]>
Implementation of IForumService.sendMessage
- Defined in @tessa/platform/src/forums/forumService.ts:80

setForumSettings

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

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

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

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

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]>
Implementation of IForumService.updateMessage
- Defined in @tessa/platform/src/forums/forumService.ts:129

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>
Implementation of IForumService.updateParticipants
- Defined in @tessa/platform/src/forums/forumService.ts:245

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>
Implementation of IForumService.updateRoles
- Defined in @tessa/platform/src/forums/forumService.ts:294

Class ForumService

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

_cardService: ICardService

_attachmentSaver: IForumAttachmentSaver

Returns ForumService

Methods

addParticipants

Returns

Parameters

topicId: string

participants: string[]

isReadOnly: boolean

type: ForumParticipantType = ForumParticipantType.Participant

isSubscribed: boolean = false

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

isArchived: boolean = true

Returns Promise<ValidationResult>

checkPermissionByFile

Returns

Parameters

fileId: string

isSuperModeratorModeEnabled: boolean

Returns Promise<ValidationResult>

getMessages

Returns

Parameters

topicId: string

isSuperModeratorModeEnabled: boolean

messagesCount: number

pageNumber: number = -1

messageId: null | string = null

lastReadMessageTime: null | string = null

isNeedUpdateLastReadMessageTime: boolean = true

searchText: null | string = null

reverseOrder: boolean = false

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

`Optional` isSubscribed: boolean

`Optional` permissionsToken: null | IStorage<unknown>

`Optional` singletonMode: boolean

`Optional` topicTypeId: null | string

`Optional` topicTypeId: null | string

`Optional` fileContentResolver: null | FileContentResolver

`Optional` fileContentResolver: null | FileContentResolver

`Optional` isReadOnly: null | boolean

`Optional` type: null | ForumParticipantType

`Optional` isSubscribed: null | boolean

`Optional` isReadOnly: boolean

`Optional` isSubscribed: boolean