MessageServiceImpl - MastermindCMS Documentation

string

Die Spring-Bean-ID des aufzurufenden Services.messageServiceImpl

string

Standard:"PROTOTYPE"

Bean-Scope. Für Serviceaufrufe wird PROTOTYPE verwendet.

string

Der öffentliche Methodenname des Services, der in der Signatur angegeben ist.

object[]

Das Argument-Array der Methode. Jedes Argument wird mit dem Index 0, 1 usw. übergeben; der Wert muss dem Java-Parametertyp entsprechen.

Headers

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

Senden Sie Lang-Context und Site-Context mit jeder Anfrage. Für geschützte Methoden senden Sie das JWT im Header Authorization im Format Bearer <token>. Zugriff: GUEST. Bearer Token: nicht erforderlich.

GUEST — nicht angemeldete Benutzer; nur Whitelist-Services sind verfügbar.
USER — Authentifizierung erforderlich; Methoden mit USER-Prüfung sind verfügbar.
ADMIN — vollständiger Zugriff auf öffentliche Methoden aller Services.
Wenn eine Methode intern eine Rolle prüft, kann GUEST null erhalten.

Methoden

Deque<Map<String, Object>>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getPaginationChats

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

LinkedHashSet<ChatDTO>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchAllChats

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

Page<Chat>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchAllChatsPaged

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

SearchResponse

Argument	Typ	Beschreibung
`searchRequest`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchChats

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`searchRequest`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchMessages

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchChats

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchMessages

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

Optional<Chat>

Argument	Typ	Beschreibung
`chatAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createChatAndNotify

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

Optional<Chat>

Argument	Typ	Beschreibung
`chatAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createChat

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

Optional<Message>

Argument	Typ	Beschreibung
`messageAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createMessageAndNotify

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

Optional<Message>

Argument	Typ	Beschreibung
`messageAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createMessage

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

readChat

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

Optional<Message>

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

readMessage

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

Optional<Chat>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

closeChat

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

Optional<Chat>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

clearActiveUsers

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

List<Message>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

getConversationByChatId

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

List<Profile>

Argument	Typ	Beschreibung
`dbName`	`String`	Übergeben über `args[0].0`.
`collection`	`String`	Übergeben über `args[1].1`.
`propertyName`	`String`	Übergeben über `args[2].2`.
`filter`	`String`	Übergeben über `args[3].3`.

getActiveContacts

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

Map<String,Object>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

getConversationPartner

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

List<Map<String,Object>>

Argument	Typ	Beschreibung
`queryExpression`	`String`	Übergeben über `args[0].0`.
`searchTerm`	`String`	Übergeben über `args[1].1`.
`sortName`	`String`	Übergeben über `args[2].2`.
`offset`	`Integer`	Übergeben über `args[3].3`.
`limit`	`Integer`	Übergeben über `args[4].4`.

getMessagesTimeline

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

Message

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

getLastMessageInChat

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

boolean

Argument	Typ	Beschreibung
`loginFromMessage`	`String`	Übergeben über `args[0].0`.

isSentMessage

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

boolean

Argument	Typ	Beschreibung
`loginFromMessage`	`String`	Übergeben über `args[0].0`.

isReplyMessage

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

boolean

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

isAttachmentExist

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

void

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

removeChatAndClean

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

void

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

removeAttachmentFromMessage

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

void

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

removeMessagesFromChat

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

void

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

removeMessageFromChatById

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

void

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

removeMessageAndClean

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

boolean

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

isRightSidedMessageAdmin

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

boolean

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

isContainsUnreadMessages

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

boolean

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

isContainsInboxUnreadMessages

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

boolean

Argument	Typ	Beschreibung
`dbName`	`String`	Übergeben über `args[0].0`.
`collection`	`String`	Übergeben über `args[1].1`.
`propertyName`	`String`	Übergeben über `args[2].2`.
`filter`	`String`	Übergeben über `args[3].3`.

isContactOnline

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

boolean

Argument	Typ	Beschreibung
`dbName`	`String`	Übergeben über `args[0].0`.
`collection`	`String`	Übergeben über `args[1].1`.
`propertyName`	`String`	Übergeben über `args[2].2`.
`filter`	`String`	Übergeben über `args[3].3`.

isNotContactOnline

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

Map<String, String>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

getUnreadMessagesCount

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

Map<String, String>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.
`profileId`	`String`	Übergeben über `args[1].1`.

getUnreadMessagesCountForUser

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

Map<String, String>

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getUnreadMessagesCountForLoggedUser

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

Map<String, Object>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.

getMessagesCountByChat

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

boolean

Argument	Typ	Beschreibung
`messageId`	`String`	Übergeben über `args[0].0`.

removeAttachmentFromMessageByLoggedUser

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

List<Attachment>

Argument	Typ	Beschreibung
`chatId`	`String`	Übergeben über `args[0].0`.
`sellerId`	`String`	Übergeben über `args[1].1`.

getChatDocumentUrls

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

​Headers

​Methoden

​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

Methoden

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