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 Summary
Modifier and TypeMethodDescriptionRetrieves a list of supported file extensions for attachments.Sends a message to the stream ID passed in parameter.Sends a message to the stream ID of the passedV4Stream
object.Sends a message to the stream ID passed in parameter.Sends a message to the stream ID passed in parameter.suppressMessage
(String messageId) Suppresses a users message based on the messageID pass in parameter.com.symphony.bdk.template.api.TemplateEngine
Returns theTemplateEngine
that can be used to load templates from classpath or file system.
-
Method Details
-
templates
com.symphony.bdk.template.api.TemplateEngine templates()Returns theTemplateEngine
that can be used to load templates from classpath or file system.- Returns:
- the template engine
-
send
Sends a message to the stream ID of the passedV4Stream
object.- Parameters:
stream
- the stream to send the message tomessage
- 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
Sends a message to the stream ID passed in parameter.- Parameters:
streamId
- the ID of the stream to send the message tomessage
- 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
Sends a message to the stream ID passed in parameter.- Parameters:
stream
- the stream to send the message tomessage
- the message to send to the stream- Returns:
- a
V4Message
object containing the details of the sent message - See Also:
-
send
Sends a message to the stream ID passed in parameter.- Parameters:
streamId
- the ID of the stream to send the message tomessage
- the message to send to the stream- Returns:
- a
V4Message
object containing the details of the sent message - See Also:
-
suppressMessage
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
Retrieves a list of supported file extensions for attachments.- Returns:
- a list of String containing all allowed file extensions for attachments
- See Also:
-