TESSA Web API
    Preparing search index...

    Interface IForumService

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

    interface IForumService {
        addParticipants(
            topicId: string,
            participants: string[],
            isReadOnly: boolean,
            type?: ForumParticipantType,
            isSubscribed?: boolean,
        ): Promise<[ForumResponse, ValidationResult]>;
        addRoles(
            topicId: string,
            roles: string[],
            isReadOnly: boolean,
            isSubscribed?: boolean,
        ): Promise<ValidationResult>;
        addTopic(
            cardId: string,
            topic: ForumTopicModel,
        ): Promise<[ForumResponse, ValidationResult]>;
        archiveTopic(
            topicId: string,
            isArchived?: boolean,
        ): Promise<ValidationResult>;
        checkPermissionByFile(
            fileId: string,
            isSuperModeratorModeEnabled: boolean,
        ): Promise<ValidationResult>;
        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]>;
        getTopic(
            id: string,
            isSuperModeratorModeEnabled: boolean,
            permissionsToken?: null | IStorage,
            singletonMode?: boolean,
            topicTypeId?: null | string,
        ): Promise<[ForumResponse, ValidationResult]>;
        getTopicsWithMessages(
            cardId: string,
            isSuperModeratorModeEnabled: boolean,
            messagesInTopicCount: number,
            lastDate: string,
            topicTypeId?: null | string,
        ): Promise<[ForumResponse, ValidationResult]>;
        removeParticipants(
            topicId: string,
            participants: string[],
        ): Promise<[ForumResponse, ValidationResult]>;
        removeRoles(
            topicId: string,
            roles: string[],
        ): Promise<[ForumResponse, ValidationResult]>;
        sendMessage(
            topicId: string,
            message: ForumMessageModel,
            isSuperModeratorModeEnabled: boolean,
            fileContentResolver?: null | FileContentResolver,
        ): Promise<[ForumResponse, ValidationResult]>;
        setForumSettings(settings: ForumSettingsModel): Promise<ValidationResult>;
        subscribe(
            topicId: string,
            isSubscribed?: boolean,
        ): Promise<ValidationResult>;
        updateMessage(
            topicId: string,
            message: ForumMessageModel,
            canEditAllMessages: boolean,
            fileContentResolver?: null | FileContentResolver,
        ): Promise<[ForumResponse, ValidationResult]>;
        updateParticipants(
            topicId: string,
            participants: string[],
            isReadOnly?: null | boolean,
            type?: null | ForumParticipantType,
            isSubscribed?: null | boolean,
        ): Promise<ValidationResult>;
        updateRoles(
            topicId: string,
            roles: string[],
            isReadOnly?: boolean,
            isSubscribed?: boolean,
        ): Promise<ValidationResult>;
    }

    Implemented by

    Index

    Methods

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

    Methods

    • Добавляет участников в топик.

      Parameters

      • topicId: string

        Идентификатор топика, в который добавляются участники.

      • participants: string[]

        Идентификаторы сотрудников, которые добавляются как участники.

      • isReadOnly: boolean

        Признак того, что у участника доступ только для чтения.

      • Optionaltype: ForumParticipantType

        Тип добавляемого участника.

      • OptionalisSubscribed: boolean

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

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Добавляет роли участников в топик.

      Parameters

      • topicId: string

        Идентификатор топика, в который добавляются роли участников.

      • roles: string[]

        Идентификаторы ролей, добавляемых в топик. Сотрудники, входящие в эти роли, имеют доступ как участники топика.

      • isReadOnly: boolean

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

      • OptionalisSubscribed: boolean

        Признак того, что участники роли подписаны.

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    • Создаёт топик.

      Parameters

      • cardId: string

        Идентификатор карточки, в которой создаётся топик.

      • topic: ForumTopicModel

        Объект, содержащий информацию по создаваемому топику.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Выполняет архивирование или разархивирование топика.

      Parameters

      • topicId: string

        Идентификатор топика, для которого выполняется действие.

      • OptionalisArchived: boolean

        true, если выполняется архивирование топика; false, если выполняется разархивирование топика.

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    • Проверяет возможность загрузить файл у пользователя в сессии.

      Parameters

      • fileId: string

        Идентификатор файла, приложенного к одному из сообщений в топике.

      • isSuperModeratorModeEnabled: boolean

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

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    • Загружает сообщения топика.

      Parameters

      • topicId: string

        Идентификатор топика, для которого загружаются сообщения.

      • isSuperModeratorModeEnabled: boolean

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

      • messagesCount: number

        Количество загружаемых сообщений.

      • OptionalpageNumber: number

        Номер загружаемой страницы. -1, если загружаются сообщения из последней страницы. Если задан параметр lastReadMessageTime, то загружается страница с указанным сообщением.

      • OptionalmessageId: null | string

        Идентификатор сообщения, которое необходимо загрузить вместе со страницей данных, или null, если страница с сообщениями загружается по порядку, без учёта конкретных сообщений.

      • OptionallastReadMessageTime: null | string

        Дата последнего прочитанного сообщения, страницу которого требуется открыть.

      • OptionalisNeedUpdateLastReadMessageTime: boolean

        Признак того, что требуется обновить дату/время последнего прочитанного сообщения для текущего пользователя.

      • OptionalsearchText: null | string

        Строка с искомым текстом, если возвращается страница с результатами поиска, или null/пустая строка, если возвращается страница c сообщениями топика без выполняемого поиска по тексту.

      • OptionalreverseOrder: boolean

        Признак того, что сообщения загружаются в обратном порядке, от самого нового к самому старому.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Возвращает информацию по указанному топику.

      Parameters

      • id: string

        Идентификатор запрашиваемого топика, если параметр singletonMode равен false, или идентификатор карточки, если параметр равен true, т.е. элемент управления находится в режиме "Единственное обсуждение".

      • isSuperModeratorModeEnabled: boolean

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

      • OptionalpermissionsToken: null | IStorage

        Токен прав доступа.

      • OptionalsingletonMode: boolean

        Признак того, что запрос выполняется для элемента управления в режиме "Единственное обсуждение".

      • OptionaltopicTypeId: null | string

        Идентификатор типа, топики которого загружаются, или null, если загружаются любые топики.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Возвращает список топиков с последними сообщениями в каждом из них.

      Parameters

      • cardId: string

        Идентификатор карточки, в которой ведутся обсуждения.

      • isSuperModeratorModeEnabled: boolean

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

      • messagesInTopicCount: number

        Максимальное количество последних сообщений, загружаемых с каждым топиком.

      • lastDate: string

        Дата отправки самого старого сообщения, после которой сообщения с топиком не загружаются.

      • OptionaltopicTypeId: null | string

        Идентификатор типа, топики которого загружаются, или null, если загружаются любые топики.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Удаляет участников топика.

      Parameters

      • topicId: string

        Идентификатор топика, участники в котором удаляются.

      • participants: string[]

        Идентификаторы сотрудников, удаляемых из списка участников топика.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Удаляет роли участников из топика.

      Parameters

      • topicId: string

        Идентификатор топика, из которого удаляются роли участников.

      • roles: string[]

        Идентификаторы ролей, удаляемые из списка участников топика.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Отправляет сообщение в топике.

      Parameters

      • topicId: string

        Идентификатор топика, в котором отправляется сообщение.

      • message: ForumMessageModel

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

      • isSuperModeratorModeEnabled: boolean

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

      • OptionalfileContentResolver: null | FileContentResolver

        Функция для получения информации по контенту файлов, содержащихся в сообщении.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Сохраняет глобальные настройки топика.

      Parameters

      • settings: ForumSettingsModel

        Объект, содержащий сохраняемые настройки.

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    • Подписывает или отписывает текущего сотрудника как участника топика.

      Parameters

      • topicId: string

        Идентификатор топика, для которого выполняется подписка или отписка.

      • OptionalisSubscribed: boolean

        true, если выполняется подписка на уведомления от топика; false, если выполняется отписка.

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    • Редактирует ранее отправленное сообщение.

      Parameters

      • topicId: string

        Идентификатор топика, в котором редактируется сообщение.

      • message: ForumMessageModel

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

      • canEditAllMessages: boolean

        Признак того, что пользователь имеет права на редактирование всех сообщений.

      • OptionalfileContentResolver: null | FileContentResolver

        Функция для получения информации по контенту файлов, содержащихся в сообщении.

      Returns Promise<[ForumResponse, ValidationResult]>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Изменяет свойства участников в топике.

      Parameters

      • topicId: string

        Идентификатор топика, в котором изменяются участники.

      • participants: string[]

        Идентификаторы изменяемых сотрудников.

      • OptionalisReadOnly: null | boolean

        Признак того, что у участника доступ только для чтения, или null, если доступ не изменяется.

      • Optionaltype: null | ForumParticipantType

        Тип участника, на который выполняется изменение, или null, если тип участника не изменяется.

      • OptionalisSubscribed: null | boolean

        Признак того, что участник подписан на уведомления, или null, если состояние подписки не изменяется.

      Returns Promise<ValidationResult>

      ForumResponse ответ на запрос; ValidationResult, содержащий информацию по возникшим ошибкам.

    • Изменяет роли участников в топике.

      Parameters

      • topicId: string

        Идентификатор топика, в котором изменяются роли участников.

      • roles: string[]

        Идентификаторы ролей, изменяемых в топике. Сотрудники, входящие в эти роли, имеют доступ как участники топика.

      • OptionalisReadOnly: boolean

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

      • OptionalisSubscribed: boolean

        Признак того, что участники роли подписаны, или null, если состояние подписки не изменяется.

      Returns Promise<ValidationResult>

      ValidationResult, содержащий информацию по возникшим ошибкам.

    Settings

    Member Visibility

    On This Page

    Methods