MessageServiceLocal (Cyclos 4.14.14 Scripting API Documentation)

All Superinterfaces:

MessageService, Service

All Known Implementing Classes:

MessageServiceImpl
```
public interface MessageServiceLocal
extends MessageService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canSendInviteMessage()`	Returns true if the logged user is allowed to send invitation messages
`boolean`	`canSendMessage(MessageDestination destination)`	Returns true if the logged user can send a message to the given destination
`boolean`	`canSendMessageToUser(User user)`	Returns true if the logged user can send a message to the given destination user.
`boolean`	`canViewMessages()`	Returns true if the the logged user can view his messages.
`void`	`removeAll(User user)`	Clears all message boxes of the specified user completely, by physically deleting all the messages

Methods inherited from interface org.cyclos.services.messaging.MessageService
countNewMessages, countUnreadMessages, getData, getSearchData, getSendData, getSendInviteMessageData, markAsRead, moveToTrash, removeAll, restoreAll, search, send, sendInviteMessage

- Method Detail
  - canSendInviteMessage
```
boolean canSendInviteMessage()
```
    Returns true if the logged user is allowed to send invitation messages
  - canSendMessage
```
boolean canSendMessage(MessageDestination destination)
```
    Returns true if the logged user can send a message to the given destination
    
    Parameters:
    
    destination - The destination of the message. If null, it returns true if the logged user can send the message to at least one destination.
  - canSendMessageToUser
```
boolean canSendMessageToUser(User user)
```
    Returns true if the logged user can send a message to the given destination user.
  - canViewMessages
```
boolean canViewMessages()
```
    Returns true if the the logged user can view his messages. In case of an admin, the method returns true if he can view the system messages.
  - removeAll
```
void removeAll(User user)
```
    Clears all message boxes of the specified user completely, by physically deleting all the messages