Package com.symphony.bdk.core.service.message

Interface OboMessageService

All Known Implementing Classes:
MessageService
@API(status=STABLE) public interface OboMessageService
Service interface exposing OBO-enabled endpoints to manage messages.
See Also:

  • Method Details

    • templates

      com.symphony.bdk.template.api.TemplateEngine templates()
      Returns the TemplateEngine that can be used to load templates from classpath or file system.
      Returns:
      the template engine

    • send

      V4Message send(@Nonnull V4Stream stream, @Nonnull String message)
      Sends a message to the stream ID of the passed V4Stream object.
      Parameters:
      stream - the stream to send the message to
      message - the MessageML content. Note: <messageML></messageML> is automatically appended if not set.
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • send

      V4Message send(@Nonnull String streamId, @Nonnull String message)
      Sends a message to the stream ID passed in parameter.
      Parameters:
      streamId - the ID of the stream to send the message to
      message - the MessageML content. Note: <messageML></messageML> is automatically appended if not set.
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • send

      V4Message send(@Nonnull V4Stream stream, @Nonnull Message message)
      Sends a message to the stream ID passed in parameter.
      Parameters:
      stream - the stream to send the message to
      message - the message to send to the stream
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • send

      V4Message send(@Nonnull String streamId, @Nonnull Message message)
      Sends a message to the stream ID passed in parameter.
      Parameters:
      streamId - the ID of the stream to send the message to
      message - the message to send to the stream
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • update

      V4Message update(@Nonnull V4Message messageToUpdate, @Nonnull Message content)
      Update an existing message. The existing message must be a valid social message, that has not been deleted.
      Parameters:
      messageToUpdate - the message to be updated
      content - the update content (attachments are not supported yet)
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • update

      V4Message update(@Nonnull String streamId, @Nonnull String messageId, @Nonnull Message content)
      Update an existing message. The existing message must be a valid social message, that has not been deleted.
      Parameters:
      streamId - the ID of the stream where the message to be updated comes from
      messageId - the ID of the message to be updated
      content - the update content (attachments are not supported yet)
      Returns:
      a V4Message object containing the details of the sent message
      See Also:

    • suppressMessage

      MessageSuppressionResponse suppressMessage(@Nonnull String messageId)
      Suppresses a users message based on the messageID pass in parameter.
      Parameters:
      messageId - the ID of the message to suppress
      Returns:
      a MessageSuppressionResponse object containing the details of the suppressed message
      See Also:

    • getAttachmentTypes

      List<String> getAttachmentTypes()
      Retrieves a list of supported file extensions for attachments.
      Returns:
      a list of String containing all allowed file extensions for attachments
      See Also: