MessageServiceImpl - MastermindCMS Documentation

string

The Spring bean identifier containing the service being called.messageServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

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

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: GUEST. Bearer Token: not required.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

Deque<Map<String, Object>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

getPaginationChats

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

LinkedHashSet<ChatDTO>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchAllChats

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

Page<Chat>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchAllChatsPaged

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

SearchResponse

Argument	Type	Description
`searchRequest`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

searchChats

Example JSON request object:

{
    "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

Argument	Type	Description
`searchRequest`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

searchMessages

Example JSON request object:

{
    "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>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchChats

Example JSON request object:

{
    "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>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchMessages

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

Optional<Chat>

Argument	Type	Description
`chatAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createChatAndNotify

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

Optional<Chat>

Argument	Type	Description
`chatAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createChat

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

Optional<Message>

Argument	Type	Description
`messageAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createMessageAndNotify

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

Optional<Message>

Argument	Type	Description
`messageAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createMessage

Example JSON request object:

{
    "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>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

readChat

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

Optional<Message>

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

readMessage

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

Optional<Chat>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

closeChat

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

Optional<Chat>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

clearActiveUsers

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

List<Message>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

getConversationByChatId

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

List<Profile>

Argument	Type	Description
`dbName`	`String`	Passed through `args[0].0`.
`collection`	`String`	Passed through `args[1].1`.
`propertyName`	`String`	Passed through `args[2].2`.
`filter`	`String`	Passed through `args[3].3`.

getActiveContacts

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

Map<String,Object>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

getConversationPartner

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

List<Map<String,Object>>

Argument	Type	Description
`queryExpression`	`String`	Passed through `args[0].0`.
`searchTerm`	`String`	Passed through `args[1].1`.
`sortName`	`String`	Passed through `args[2].2`.
`offset`	`Integer`	Passed through `args[3].3`.
`limit`	`Integer`	Passed through `args[4].4`.

getMessagesTimeline

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

Message

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

getLastMessageInChat

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

boolean

Argument	Type	Description
`loginFromMessage`	`String`	Passed through `args[0].0`.

isSentMessage

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

boolean

Argument	Type	Description
`loginFromMessage`	`String`	Passed through `args[0].0`.

isReplyMessage

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

boolean

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

isAttachmentExist

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

void

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

removeChatAndClean

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

void

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

removeAttachmentFromMessage

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

void

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

removeMessagesFromChat

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

void

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

removeMessageFromChatById

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

void

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

removeMessageAndClean

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

boolean

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

isRightSidedMessageAdmin

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

boolean

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

isContainsUnreadMessages

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

boolean

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

isContainsInboxUnreadMessages

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

boolean

Argument	Type	Description
`dbName`	`String`	Passed through `args[0].0`.
`collection`	`String`	Passed through `args[1].1`.
`propertyName`	`String`	Passed through `args[2].2`.
`filter`	`String`	Passed through `args[3].3`.

isContactOnline

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

boolean

Argument	Type	Description
`dbName`	`String`	Passed through `args[0].0`.
`collection`	`String`	Passed through `args[1].1`.
`propertyName`	`String`	Passed through `args[2].2`.
`filter`	`String`	Passed through `args[3].3`.

isNotContactOnline

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

Map<String, String>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

getUnreadMessagesCount

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

Map<String, String>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.
`profileId`	`String`	Passed through `args[1].1`.

getUnreadMessagesCountForUser

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

Map<String, String>

Argument	Type	Description
—	—	This method does not accept arguments.

getUnreadMessagesCountForLoggedUser

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

Map<String, Object>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.

getMessagesCountByChat

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

boolean

Argument	Type	Description
`messageId`	`String`	Passed through `args[0].0`.

removeAttachmentFromMessageByLoggedUser

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

List<Attachment>

Argument	Type	Description
`chatId`	`String`	Passed through `args[0].0`.
`sellerId`	`String`	Passed through `args[1].1`.

getChatDocumentUrls

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

​Headers

​Methods

​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

Methods

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