MessageServiceImpl - MastermindCMS Documentation

string

Идентификатор Spring bean, который содержит вызываемый сервис.messageServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

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

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST. Bearer Token: не требуется.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

Deque<Map<String, Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getPaginationChats

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationChats",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<ChatDTO>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchAllChats

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchAllChats",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Chat>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchAllChatsPaged

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchAllChatsPaged",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Аргумент	Тип	Описание
`searchRequest`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

searchChats

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchChats",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Аргумент	Тип	Описание
`searchRequest`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

searchMessages

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchMessages",
  "args": [
    {
      "0": null
    }
  ]
}

List<ChatDTO>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchChats

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchChats",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String,Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchMessages

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchMessages",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Chat>

Аргумент	Тип	Описание
`chatAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createChatAndNotify

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createChatAndNotify",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Chat>

Аргумент	Тип	Описание
`chatAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createChat",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Message>

Аргумент	Тип	Описание
`messageAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createMessageAndNotify

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createMessageAndNotify",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Message>

Аргумент	Тип	Описание
`messageAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createMessage

Пример JSON объекта запроса:

{
    "id":  null,
    "messageText":  null,
    "from":  null,
    "to":  null,
    "messageState":  null,
    "embeddedChat":  null,
    "attachedFile":  null,
    "score":  0
}

Request:

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createMessage",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Chat>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

readChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "readChat",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Message>

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

readMessage

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "readMessage",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Chat>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

closeChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "closeChat",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Chat>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

clearActiveUsers

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "clearActiveUsers",
  "args": [
    {
      "0": null
    }
  ]
}

List<Message>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

getConversationByChatId

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getConversationByChatId",
  "args": [
    {
      "0": null
    }
  ]
}

List<Profile>

Аргумент	Тип	Описание
`dbName`	`String`	Передаётся через `args[0].0`.
`collection`	`String`	Передаётся через `args[1].1`.
`propertyName`	`String`	Передаётся через `args[2].2`.
`filter`	`String`	Передаётся через `args[3].3`.

getActiveContacts

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getActiveContacts",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null,
      "3": null
    }
  ]
}

Map<String,Object>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

getConversationPartner

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getConversationPartner",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String,Object>>

Аргумент	Тип	Описание
`queryExpression`	`String`	Передаётся через `args[0].0`.
`searchTerm`	`String`	Передаётся через `args[1].1`.
`sortName`	`String`	Передаётся через `args[2].2`.
`offset`	`Integer`	Передаётся через `args[3].3`.
`limit`	`Integer`	Передаётся через `args[4].4`.

getMessagesTimeline

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getMessagesTimeline",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null,
      "3": null,
      "4": null
    }
  ]
}

Message

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

getLastMessageInChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLastMessageInChat",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`loginFromMessage`	`String`	Передаётся через `args[0].0`.

isSentMessage

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isSentMessage",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`loginFromMessage`	`String`	Передаётся через `args[0].0`.

isReplyMessage

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isReplyMessage",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

isAttachmentExist

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isAttachmentExist",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

removeChatAndClean

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeChatAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

removeAttachmentFromMessage

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAttachmentFromMessage",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

removeMessagesFromChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeMessagesFromChat",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

removeMessageFromChatById

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeMessageFromChatById",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

removeMessageAndClean

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeMessageAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

isRightSidedMessageAdmin

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isRightSidedMessageAdmin",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

isContainsUnreadMessages

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isContainsUnreadMessages",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

isContainsInboxUnreadMessages

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isContainsInboxUnreadMessages",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`dbName`	`String`	Передаётся через `args[0].0`.
`collection`	`String`	Передаётся через `args[1].1`.
`propertyName`	`String`	Передаётся через `args[2].2`.
`filter`	`String`	Передаётся через `args[3].3`.

isContactOnline

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isContactOnline",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null,
      "3": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`dbName`	`String`	Передаётся через `args[0].0`.
`collection`	`String`	Передаётся через `args[1].1`.
`propertyName`	`String`	Передаётся через `args[2].2`.
`filter`	`String`	Передаётся через `args[3].3`.

isNotContactOnline

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isNotContactOnline",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null,
      "3": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

getUnreadMessagesCount

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getUnreadMessagesCount",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.
`profileId`	`String`	Передаётся через `args[1].1`.

getUnreadMessagesCountForUser

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getUnreadMessagesCountForUser",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getUnreadMessagesCountForLoggedUser

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getUnreadMessagesCountForLoggedUser",
  "args": []
}

Map<String, Object>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.

getMessagesCountByChat

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getMessagesCountByChat",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`messageId`	`String`	Передаётся через `args[0].0`.

removeAttachmentFromMessageByLoggedUser

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAttachmentFromMessageByLoggedUser",
  "args": [
    {
      "0": null
    }
  ]
}

List<Attachment>

Аргумент	Тип	Описание
`chatId`	`String`	Передаётся через `args[0].0`.
`sellerId`	`String`	Передаётся через `args[1].1`.

getChatDocumentUrls

{
  "beanId": "messageServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getChatDocumentUrls",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

​Headers

​Методы

​getPaginationChats

​searchAllChats

​searchAllChatsPaged

​searchChats

​searchMessages

​searchChats

​searchMessages

​createChatAndNotify

​createChat

​createMessageAndNotify

​createMessage

​readChat

​readMessage

​closeChat

​clearActiveUsers

​getConversationByChatId

​getActiveContacts

​getConversationPartner

​getMessagesTimeline

​getLastMessageInChat

​isSentMessage

​isReplyMessage

​isAttachmentExist

​removeChatAndClean

​removeAttachmentFromMessage

​removeMessagesFromChat

​removeMessageFromChatById

​removeMessageAndClean

​isRightSidedMessageAdmin

​isContainsUnreadMessages

​isContainsInboxUnreadMessages

​isContactOnline

​isNotContactOnline

​getUnreadMessagesCount

​getUnreadMessagesCountForUser

​getUnreadMessagesCountForLoggedUser

​getMessagesCountByChat

​removeAttachmentFromMessageByLoggedUser

​getChatDocumentUrls

Headers

Методы

getPaginationChats

searchAllChats

searchAllChatsPaged

searchChats

searchMessages

searchChats

searchMessages

createChatAndNotify

createChat

createMessageAndNotify

createMessage

readChat

readMessage

closeChat

clearActiveUsers

getConversationByChatId

getActiveContacts

getConversationPartner

getMessagesTimeline

getLastMessageInChat

isSentMessage

isReplyMessage

isAttachmentExist

removeChatAndClean

removeAttachmentFromMessage

removeMessagesFromChat

removeMessageFromChatById

removeMessageAndClean

isRightSidedMessageAdmin

isContainsUnreadMessages

isContainsInboxUnreadMessages

isContactOnline

isNotContactOnline

getUnreadMessagesCount

getUnreadMessagesCountForUser

getUnreadMessagesCountForLoggedUser

getMessagesCountByChat

removeAttachmentFromMessageByLoggedUser

getChatDocumentUrls