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:

Message API

Method Summary

Modifier and Type	Method and Description
V4Message	send(java.lang.String streamId, Message message) Sends a message to the stream ID passed in parameter.
V4Message	send(java.lang.String streamId, java.lang.String message) Sends a message to the stream ID passed in parameter.
V4Message	send(V4Stream stream, Message message) Sends a message to the stream ID passed in parameter.
V4Message	send(V4Stream stream, java.lang.String message) Sends a message to the stream ID of the passed V4Stream object.
MessageSuppressionResponse	suppressMessage(java.lang.String messageId) Suppresses a users message based on the messageID pass in parameter.
com.symphony.bdk.template.api.TemplateEngine	templates() Returns the TemplateEngine that can be used to load templates from classpath or file system.

Method Detail

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
               java.lang.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:

Create Message v4

send

V4Message send(@Nonnull
               java.lang.String streamId,
               @Nonnull
               java.lang.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:

Create Message v4

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:

Create Message v4

send

V4Message send(@Nonnull
               java.lang.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:

Create Message v4

suppressMessage

MessageSuppressionResponse suppressMessage(@Nonnull
                                           java.lang.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:

Suppress Message