Package de.espirit.firstspirit.access

Interface MessageService

public interface MessageService
Service interface for sending messages via the server to other users, all users or usergroups.
Use getService(MessageService.class) to request an instance of this service.
Since:
4.0.70
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    sendMessage(@NotNull String message)
    Sends the given message to all users logged in on the server.
    This message will be visible in all java- and webeditclients and in all webmonitor and startpage sessions.
    void
    sendMessage(@NotNull String message, @NotNull Group recipientGroup)
    Sends the given message to the users contained in the given usergroup.
    void
    sendMessage(@NotNull String message, @NotNull List<User> recipients)
    Sends the given message to the users specified by the given recipients list.

  • Method Details

    • sendMessage

      void sendMessage(@NotNull @NotNull String message)
      Sends the given message to all users logged in on the server.
      This message will be visible in all java- and webeditclients and in all webmonitor and startpage sessions.
      Parameters:
      message - the message to be send
      Since:
      4.0.70

    • sendMessage

      void sendMessage(@NotNull @NotNull String message, @NotNull @NotNull List<User> recipients)
      Sends the given message to the users specified by the given recipients list. This user specific message will be only visible for users logged in with java clients
      Parameters:
      message - the message to be send
      recipients - the users which will receive the message
      Since:
      4.0.70

    • sendMessage

      void sendMessage(@NotNull @NotNull String message, @NotNull @NotNull Group recipientGroup)
      Sends the given message to the users contained in the given usergroup. This user specific message will be only visible for users logged in with java clients
      Parameters:
      message - the message to be send
      recipientGroup - the group which members should receive the message
      Since:
      4.0.70