com.symphony.bdk.core.service.message

Class MessageService

java.lang.Object

com.symphony.bdk.core.service.message.MessageService

All Implemented Interfaces:

OboMessageService, OboService<OboMessageService>

@API(status=STABLE)
public class MessageService
extends java.lang.Object
implements OboMessageService, OboService<OboMessageService>

Service class for managing messages.

See Also:

Message API

Constructor Summary

Constructors

Constructor and Description
MessageService(MessagesApi messagesApi, MessageApi messageApi, MessageSuppressionApi messageSuppressionApi, StreamsApi streamsApi, PodApi podApi, AttachmentsApi attachmentsApi, DefaultApi defaultApi, AuthSession authSession, com.symphony.bdk.template.api.TemplateEngine templateEngine, RetryWithRecoveryBuilder<?> retryBuilder)
MessageService(MessagesApi messagesApi, MessageApi messageApi, MessageSuppressionApi messageSuppressionApi, StreamsApi streamsApi, PodApi podApi, AttachmentsApi attachmentsApi, DefaultApi defaultApi, com.symphony.bdk.template.api.TemplateEngine templateEngine, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method and Description
byte[]	getAttachment(java.lang.String streamId, java.lang.String messageId, java.lang.String attachmentId) Downloads the attachment body by the stream ID, message ID and attachment ID.
java.util.List<java.lang.String>	getAttachmentTypes() Retrieves a list of supported file extensions for attachments.
V4Message	getMessage(java.lang.String messageId) Retrieves the details of a message given its message ID.
MessageMetadataResponse	getMessageRelationships(java.lang.String messageId) Gets the message metadata relationship.
MessageStatus	getMessageStatus(java.lang.String messageId) Get the status of a particular message, i.e the list of users who the message was sent to, delivered to and the list of users who read the message.
java.util.List<V4ImportResponse>	importMessages(java.util.List<V4ImportedMessage> messages) Imports a list of messages to Symphony
java.util.List<StreamAttachmentItem>	listAttachments(java.lang.String streamId, java.time.Instant since, java.time.Instant to, java.lang.Integer limit, AttachmentSort sort) List attachments in a particular stream.
MessageReceiptDetailResponse	listMessageReceipts(java.lang.String messageId) Fetches receipts details from a specific message.
java.util.List<V4Message>	listMessages(java.lang.String streamId, java.time.Instant since) Get messages from an existing stream with default limit equals 50.
java.util.List<V4Message>	listMessages(java.lang.String streamId, java.time.Instant since, PaginationAttribute pagination) Get messages from an existing stream.
java.util.List<V4Message>	listMessages(V4Stream stream, java.time.Instant since) Get messages from an existing stream with default limit equals 50.
java.util.List<V4Message>	listMessages(V4Stream stream, java.time.Instant since, PaginationAttribute pagination) Get messages from an existing stream.
OboMessageService	obo(AuthSession oboSession) Returns a new service instance with OBO-enabled endpoints from a given OBO session.
V4MessageBlastResponse	send(java.util.List<java.lang.String> streamIds, Message message) Sends a message to multiple existing streams.
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 message, preventing its contents from being displayed to users.
com.symphony.bdk.template.api.TemplateEngine	templates() Returns the TemplateEngine that can be used to load templates from classpath or file system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.symphony.bdk.core.service.OboService

checkAuthSession

Constructor Detail

MessageService

public MessageService(MessagesApi messagesApi,
                      MessageApi messageApi,
                      MessageSuppressionApi messageSuppressionApi,
                      StreamsApi streamsApi,
                      PodApi podApi,
                      AttachmentsApi attachmentsApi,
                      DefaultApi defaultApi,
                      AuthSession authSession,
                      com.symphony.bdk.template.api.TemplateEngine templateEngine,
                      RetryWithRecoveryBuilder<?> retryBuilder)

MessageService

public MessageService(MessagesApi messagesApi,
                      MessageApi messageApi,
                      MessageSuppressionApi messageSuppressionApi,
                      StreamsApi streamsApi,
                      PodApi podApi,
                      AttachmentsApi attachmentsApi,
                      DefaultApi defaultApi,
                      com.symphony.bdk.template.api.TemplateEngine templateEngine,
                      RetryWithRecoveryBuilder<?> retryBuilder)

Method Detail

obo

public OboMessageService obo(AuthSession oboSession)

Description copied from interface: OboService

Returns a new service instance with OBO-enabled endpoints from a given OBO session.

Specified by:

obo in interface OboService<OboMessageService>

Parameters:

oboSession - the OBO session

Returns:

the instance of the service class with OBO-enabled endpoints

templates

public com.symphony.bdk.template.api.TemplateEngine templates()

Returns the TemplateEngine that can be used to load templates from classpath or file system.

Specified by:

templates in interface OboMessageService

Returns:

the template engine

listMessages

public java.util.List<V4Message> listMessages(@Nonnull
                                              V4Stream stream,
                                              @Nonnull
                                              java.time.Instant since,
                                              @Nonnull
                                              PaginationAttribute pagination)

Get messages from an existing stream. Additionally returns any attachments associated with the message.

Parameters:

stream - the stream where to look for messages

since - instant of the earliest possible date of the first message returned.

pagination - The skip and limit for pagination.

Returns:

the list of matching messages in the stream.

See Also:

Messages

listMessages

public java.util.List<V4Message> listMessages(@Nonnull
                                              V4Stream stream,
                                              @Nonnull
                                              java.time.Instant since)

Get messages from an existing stream with default limit equals 50. Additionally returns any attachments associated with the message.

Parameters:

stream - the stream where to look for messages

since - instant of the earliest possible date of the first message returned.

Returns:

the list of matching messages in the stream.

See Also:

Messages

listMessages

public java.util.List<V4Message> listMessages(@Nonnull
                                              java.lang.String streamId,
                                              @Nonnull
                                              java.time.Instant since,
                                              @Nonnull
                                              PaginationAttribute pagination)

Get messages from an existing stream. Additionally returns any attachments associated with the message.

Parameters:

streamId - the streamID where to look for messages

since - instant of the earliest possible date of the first message returned.

pagination - The skip and limit for pagination.

Returns:

the list of matching messages in the stream.

See Also:

Messages

listMessages

public java.util.List<V4Message> listMessages(@Nonnull
                                              java.lang.String streamId,
                                              @Nonnull
                                              java.time.Instant since)

Get messages from an existing stream with default limit equals 50. Additionally returns any attachments associated with the message.

Parameters:

streamId - the streamID where to look for messages

since - instant of the earliest possible date of the first message returned.

Returns:

the list of matching messages in the stream.

See Also:

Messages

send

public V4Message send(@Nonnull
                      V4Stream stream,
                      @Nonnull
                      java.lang.String message)

Sends a message to the stream ID of the passed V4Stream object.

Specified by:

send in interface OboMessageService

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

public V4Message send(@Nonnull
                      java.lang.String streamId,
                      @Nonnull
                      java.lang.String message)

Sends a message to the stream ID passed in parameter.

Specified by:

send in interface OboMessageService

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

public V4Message send(@Nonnull
                      V4Stream stream,
                      @Nonnull
                      Message message)

Sends a message to the stream ID passed in parameter.

Specified by:

send in interface OboMessageService

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

public V4Message send(@Nonnull
                      java.lang.String streamId,
                      @Nonnull
                      Message message)

Sends a message to the stream ID passed in parameter.

Specified by:

send in interface OboMessageService

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

send

public V4MessageBlastResponse send(@Nonnull
                                   java.util.List<java.lang.String> streamIds,
                                   @Nonnull
                                   Message message)

Sends a message to multiple existing streams.

Parameters:

streamIds - the list of stream IDs to send the message to

message - the message to be sent

Returns:

a V4MessageBlastResponse object containing the details of the sent messages

See Also:

Blast Message

getAttachment

public byte[] getAttachment(@Nonnull
                            java.lang.String streamId,
                            @Nonnull
                            java.lang.String messageId,
                            @Nonnull
                            java.lang.String attachmentId)

Downloads the attachment body by the stream ID, message ID and attachment ID.

Parameters:

streamId - the stream ID where to look for the attachment

messageId - the ID of the message containing the attachment

attachmentId - the ID of the attachment

Returns:

a byte array of attachment encoded in base 64

See Also:

Attachment

importMessages

public java.util.List<V4ImportResponse> importMessages(@Nonnull
                                                       java.util.List<V4ImportedMessage> messages)

Imports a list of messages to Symphony

Parameters:

messages - the list of messages to be imported

Returns:

the list of imported messages

See Also:

Import Message

suppressMessage

public MessageSuppressionResponse suppressMessage(@Nonnull
                                                  java.lang.String messageId)

Suppresses a message, preventing its contents from being displayed to users.

Parameters:

messageId - the ID of the message to suppress.

Returns:

a MessageSuppressionResponse instance containing information about the message suppression.

See Also:

Suppress Message

getMessageStatus

public MessageStatus getMessageStatus(@Nonnull
                                      java.lang.String messageId)

Get the status of a particular message, i.e the list of users who the message was sent to, delivered to and the list of users who read the message.

Parameters:

messageId - the ID of the message to be checked

Returns:

a MessageStatus instance

See Also:

Message Status

getAttachmentTypes

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

Attachment Types

getMessage

public V4Message getMessage(@Nonnull
                            java.lang.String messageId)

Retrieves the details of a message given its message ID.

Parameters:

messageId - the ID of the message to be retrieved

Returns:

a V4Message containing the message's details, null if the message was not found

See Also:

Get Message v1

listAttachments

public java.util.List<StreamAttachmentItem> listAttachments(@Nonnull
                                                            java.lang.String streamId,
                                                            @Nullable
                                                            java.time.Instant since,
                                                            @Nullable
                                                            java.time.Instant to,
                                                            @Nullable
                                                            java.lang.Integer limit,
                                                            @Nullable
                                                            AttachmentSort sort)

List attachments in a particular stream.

Parameters:

streamId - the stream ID where to look for the attachments

since - optional instant of the first required attachment.

to - optional instant of the last required attachment.

limit - maximum number of attachments to return. This optional value defaults to 50 and should be between 0 and 100.

sort - Attachment date sort direction : ASC or DESC (default to ASC)

Returns:

the list of attachments in the stream.

See Also:

List Attachments

listMessageReceipts

public MessageReceiptDetailResponse listMessageReceipts(@Nonnull
                                                        java.lang.String messageId)

Fetches receipts details from a specific message.

Parameters:

messageId - the ID of the message to get receipt details from.

Returns:

a MessageReceiptDetailResponse object holding all receipt information.

See Also:

List Message Receipts

getMessageRelationships

public MessageMetadataResponse getMessageRelationships(@Nonnull
                                                       java.lang.String messageId)

Gets the message metadata relationship. This API allows users to track the relationship between a message and all the forwards and replies of that message.

Parameters:

messageId - the ID of the message to get relationships from.

Returns:

a MessageMetadataResponse object holding information about the current message relationships (parent, replies, forwards and form replies).

See Also:

Message Metadata