Constructor Detail

Method Detail

• withRawResponse

   abstract MessageService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• batch

   abstract BatchService batch()

• activities

   abstract ActivityService activities()

• list

   MessageListPage list()

  Returns a paginated list of messages for the current environment.

• list

   abstract MessageListPage list(MessageListParams params, RequestOptions requestOptions)

• list

   MessageListPage list(MessageListParams params)

• list

   MessageListPage list(RequestOptions requestOptions)

• archive

   Message archive(String messageId)

  Archives a message for the user. Archived messages are hidden from the default message list in the feed but can still be accessed and unarchived later.

• archive

   Message archive(String messageId, MessageArchiveParams params, RequestOptions requestOptions)

• archive

   Message archive(String messageId, MessageArchiveParams params)

• archive

   abstract Message archive(MessageArchiveParams params, RequestOptions requestOptions)

• archive

   Message archive(MessageArchiveParams params)

• archive

   Message archive(String messageId, RequestOptions requestOptions)

• get

   Message get(String messageId)

  Retrieves a specific message by its ID.

• get

   Message get(String messageId, MessageGetParams params, RequestOptions requestOptions)

• get

   Message get(String messageId, MessageGetParams params)

• get

   abstract Message get(MessageGetParams params, RequestOptions requestOptions)

• get

   Message get(MessageGetParams params)

• get

   Message get(String messageId, RequestOptions requestOptions)

• getContent

   MessageGetContentResponse getContent(String messageId)

  Returns the fully rendered contents of a message, where the response depends on which channel the message was sent through.

• getContent

   MessageGetContentResponse getContent(String messageId, MessageGetContentParams params, RequestOptions requestOptions)

• getContent

   MessageGetContentResponse getContent(String messageId, MessageGetContentParams params)

• getContent

   abstract MessageGetContentResponse getContent(MessageGetContentParams params, RequestOptions requestOptions)

• getContent

   MessageGetContentResponse getContent(MessageGetContentParams params)

• getContent

   MessageGetContentResponse getContent(String messageId, RequestOptions requestOptions)

• listActivities

   MessageListActivitiesPage listActivities(String messageId)

  Returns a paginated list of activities for the specified message.

• listActivities

   MessageListActivitiesPage listActivities(String messageId, MessageListActivitiesParams params, RequestOptions requestOptions)

• listActivities

   MessageListActivitiesPage listActivities(String messageId, MessageListActivitiesParams params)

• listActivities

   abstract MessageListActivitiesPage listActivities(MessageListActivitiesParams params, RequestOptions requestOptions)

• listActivities

   MessageListActivitiesPage listActivities(MessageListActivitiesParams params)

• listActivities

   MessageListActivitiesPage listActivities(String messageId, RequestOptions requestOptions)

• listDeliveryLogs

   MessageListDeliveryLogsPage listDeliveryLogs(String messageId)

  Returns a paginated list of delivery logs for the specified message.

• listDeliveryLogs

   MessageListDeliveryLogsPage listDeliveryLogs(String messageId, MessageListDeliveryLogsParams params, RequestOptions requestOptions)

• listDeliveryLogs

   MessageListDeliveryLogsPage listDeliveryLogs(String messageId, MessageListDeliveryLogsParams params)

• listDeliveryLogs

   abstract MessageListDeliveryLogsPage listDeliveryLogs(MessageListDeliveryLogsParams params, RequestOptions requestOptions)

• listDeliveryLogs

   MessageListDeliveryLogsPage listDeliveryLogs(MessageListDeliveryLogsParams params)

• listDeliveryLogs

   MessageListDeliveryLogsPage listDeliveryLogs(String messageId, RequestOptions requestOptions)

• listEvents

   MessageListEventsPage listEvents(String messageId)

  Returns a paginated list of events for the specified message.

• listEvents

   MessageListEventsPage listEvents(String messageId, MessageListEventsParams params, RequestOptions requestOptions)

• listEvents

   MessageListEventsPage listEvents(String messageId, MessageListEventsParams params)

• listEvents

   abstract MessageListEventsPage listEvents(MessageListEventsParams params, RequestOptions requestOptions)

• listEvents

   MessageListEventsPage listEvents(MessageListEventsParams params)

• listEvents

   MessageListEventsPage listEvents(String messageId, RequestOptions requestOptions)

• markAsInteracted

   Message markAsInteracted(String messageId)

  Marks a message as interacted with by the user. This can include any user action on the message, with optional metadata about the specific interaction. Cannot include more than 5 key-value pairs, must not contain nested data. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.

• markAsInteracted

   Message markAsInteracted(String messageId, MessageMarkAsInteractedParams params, RequestOptions requestOptions)

• markAsInteracted

   Message markAsInteracted(String messageId, MessageMarkAsInteractedParams params)

• markAsInteracted

   abstract Message markAsInteracted(MessageMarkAsInteractedParams params, RequestOptions requestOptions)

• markAsInteracted

   Message markAsInteracted(MessageMarkAsInteractedParams params)

• markAsInteracted

   Message markAsInteracted(String messageId, RequestOptions requestOptions)

• markAsRead

   Message markAsRead(String messageId)

  Marks a message as read. This indicates that the user has read the message content. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.

• markAsRead

   Message markAsRead(String messageId, MessageMarkAsReadParams params, RequestOptions requestOptions)

• markAsRead

   Message markAsRead(String messageId, MessageMarkAsReadParams params)

• markAsRead

   abstract Message markAsRead(MessageMarkAsReadParams params, RequestOptions requestOptions)

• markAsRead

   Message markAsRead(MessageMarkAsReadParams params)

• markAsRead

   Message markAsRead(String messageId, RequestOptions requestOptions)

• markAsSeen

   Message markAsSeen(String messageId)

  Marks a message as seen. This indicates that the user has viewed the message in their feed or inbox. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.

• markAsSeen

   Message markAsSeen(String messageId, MessageMarkAsSeenParams params, RequestOptions requestOptions)

• markAsSeen

   Message markAsSeen(String messageId, MessageMarkAsSeenParams params)

• markAsSeen

   abstract Message markAsSeen(MessageMarkAsSeenParams params, RequestOptions requestOptions)

• markAsSeen

   Message markAsSeen(MessageMarkAsSeenParams params)

• markAsSeen

   Message markAsSeen(String messageId, RequestOptions requestOptions)

• markAsUnread

   Message markAsUnread(String messageId)

  Marks a message as unread. This reverses the read state. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.

• markAsUnread

   Message markAsUnread(String messageId, MessageMarkAsUnreadParams params, RequestOptions requestOptions)

• markAsUnread

   Message markAsUnread(String messageId, MessageMarkAsUnreadParams params)

• markAsUnread

   abstract Message markAsUnread(MessageMarkAsUnreadParams params, RequestOptions requestOptions)

• markAsUnread

   Message markAsUnread(MessageMarkAsUnreadParams params)

• markAsUnread

   Message markAsUnread(String messageId, RequestOptions requestOptions)

• markAsUnseen

   Message markAsUnseen(String messageId)

  Marks a message as unseen. This reverses the seen state. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.

• markAsUnseen

   Message markAsUnseen(String messageId, MessageMarkAsUnseenParams params, RequestOptions requestOptions)

• markAsUnseen

   Message markAsUnseen(String messageId, MessageMarkAsUnseenParams params)

• markAsUnseen

   abstract Message markAsUnseen(MessageMarkAsUnseenParams params, RequestOptions requestOptions)

• markAsUnseen

   Message markAsUnseen(MessageMarkAsUnseenParams params)

• markAsUnseen

   Message markAsUnseen(String messageId, RequestOptions requestOptions)

• unarchive

   Message unarchive(String messageId)

  Removes a message from the archived state, making it visible in the default message list in the feed again.

• unarchive

   Message unarchive(String messageId, MessageUnarchiveParams params, RequestOptions requestOptions)

• unarchive

   Message unarchive(String messageId, MessageUnarchiveParams params)

• unarchive

   abstract Message unarchive(MessageUnarchiveParams params, RequestOptions requestOptions)

• unarchive

   Message unarchive(MessageUnarchiveParams params)

• unarchive

   Message unarchive(String messageId, RequestOptions requestOptions)