public interface OobProviderToUserMessage extends OobIncomingMessage, OobMessageMeta
Modifier and Type | Method and Description |
---|---|
OobUserToProviderMessage |
createResponse(String locale,
Date createTime,
SecureString subject,
String from,
String contentType,
SecureByteArray content,
OobUserMessageAttachment[] attachments,
Map<String,String> meta)
Create an outgoing response for the current message.
|
OobUserMessageAttachment[] |
getAttachments()
Get messages attachments.
|
SecureByteArray |
getContent()
Get message content.
|
SecureString |
getContentStr()
Get message content in form of secure string.
|
SecureString |
getContentStr(String charsetName)
Get message content in form of secure string in specific encoding format.
|
String |
getContentType()
Get the content type of the generic message.
|
Date |
getCreateTime()
Get the message creation date.
|
String |
getFrom()
Get the message originator.
|
String |
getLocale()
Get the locale the message content is for.
|
String |
getReplyTo()
Get the recipient to use for a response.
|
SecureString |
getSubject()
Get message subject
|
String |
getThreadId()
Get the message thread identifier.
|
String |
getTo()
Get the message recipient.
|
createOobError, createOobError, getExpirationDate, getMessageType, isAcknowledgmentRequested
getMessageId, getMessageMIMEType, getProviderId, wipe
getMeta
String getLocale()
String getContentType()
SecureByteArray getContent()
SecureString getContentStr()
SecureString getSubject()
SecureString getContentStr(String charsetName)
charsetName
- The character encoding.Date getCreateTime()
String getFrom()
String getTo()
String getReplyTo()
String getThreadId()
OobUserMessageAttachment[] getAttachments()
OobUserToProviderMessage createResponse(String locale, Date createTime, SecureString subject, String from, String contentType, SecureByteArray content, OobUserMessageAttachment[] attachments, Map<String,String> meta)
The recipient field ('To') of the created message is set to the value of the response recipient ('ReplyTo') of the incoming message.
The response thread identifier field ('threadId') is set to the same value than the incoming message.
locale
- Locale to use to handle messages.createTime
- Message creation time. The value cannot be null.subject
- Message subject.from
- Message originator. Can be null.contentType
- Message content-type.content
- Message content.attachments
- Array of attachments to the message. Can be null.meta
- Meta data for the message. Can be null.