MessageManager

Method Summary
Message	createEnterpriseMessage(String messageType, EnterpriseInfo enterprise, Profile sender, String recipientEmail, String subject, String message) Creates a message intended for the recipient profile associated with the specified enterprise. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.
Message	createEnterpriseMessage(String messageType, Packet packet, EnterpriseInfo enterprise, Profile sender, String recipientEmail, String subject, String message) Creates a message intended for the recipient profile associated with the specified enterprise and associates it with the packet. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.
Message	createMessage(String messageType, Packet packet, String subject, String message) Creates a message and associates it with the packet. This message has no receiver or sender associated with it.
Message	createMessage(String messageType, String subject, String message) Creates a message. This message has no receiver or sender associated with it.
Message	createPersonalMessage(String messageType, Packet packet, Profile sender, String recipientEmail, String subject, String message) Creates a message for the target recipient's personal profile and associated with the packet. Sender profile is optional.
Message	createPersonalMessage(String messageType, Profile sender, String recipientEmail, String subject, String message) Creates a message for the target recipient's personal profile. Sender profile is optional.
	deleteMessage(String messageId) Deletes the specified message.
int	deleteMessages(String[] messageIds) Deletes the specified messages.
Message	getMessage(String messageId) Returns the message identified by messageId. Returns null if message with specified id not found.
SystemDataView	getMessageInbox(Profile profile) Returns messages where the profile is the recipient.
SystemDataView	getMessages() Returns all messages associated with this Pal.
SystemDataView	getMessagesSent(Profile profile) Returns messages where the profile is the sender.
SystemDataView	getTransactionMessages(String txId) Returns messages associated with the transaction.
String	toString() Returns a description of this object.

Method Detail

Message createEnterpriseMessage(String messageType, EnterpriseInfo enterprise, Profile sender, String recipientEmail, String subject, String message)

Creates a message intended for the recipient profile associated with the specified enterprise. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
EnterpriseInfo enterprise Required parameter.
Profile sender
String recipientEmail Required parameter. Maximum allowed size of parameter: 80
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-10-2013

top

Message createEnterpriseMessage(String messageType, Packet packet, EnterpriseInfo enterprise, Profile sender, String recipientEmail, String subject, String message)

Creates a message intended for the recipient profile associated with the specified enterprise and associates it with the packet. Returns null if no enterprise profile is found for the recipient. Sender profile is optional.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
Packet packet Required parameter.
EnterpriseInfo enterprise Required parameter.
Profile sender
String recipientEmail Required parameter. Maximum allowed size of parameter: 80
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-10-2013

top

Message createMessage(String messageType, Packet packet, String subject, String message)

Creates a message and associates it with the packet. This message has no receiver or sender associated with it.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
Packet packet Required parameter.
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-16-2013

top

Message createMessage(String messageType, String subject, String message)

Creates a message. This message has no receiver or sender associated with it.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-16-2013

top

Message createPersonalMessage(String messageType, Packet packet, Profile sender, String recipientEmail, String subject, String message)

Creates a message for the target recipient's personal profile and associated with the packet. Sender profile is optional.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
Packet packet Required parameter.
Profile sender
String recipientEmail Required parameter. Maximum allowed size of parameter: 80
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-10-2013

top

Message createPersonalMessage(String messageType, Profile sender, String recipientEmail, String subject, String message)

Creates a message for the target recipient's personal profile. Sender profile is optional.

Parameters:

String messageType - Required, but can be whatever you want. Required parameter. Maximum allowed size of parameter: 20
Profile sender
String recipientEmail Required parameter. Maximum allowed size of parameter: 80
String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-10-2013

top

deleteMessage(String messageId)

Deletes the specified message.

Parameters:

String messageId Required parameter.

Since: 01-10-2013

top

int deleteMessages(String[] messageIds)

Deletes the specified messages.

Parameters:

String[] messageIds - Array of message ids to delete. Required parameter.

Returns: int

Since: 01-10-2013

top

Message getMessage(String messageId)

Returns the message identified by messageId. Returns null if message with specified id not found.

Parameters:

String messageId Required parameter.

Returns: Message

Since: 01-10-2013

top

SystemDataView getMessageInbox(Profile profile)

Returns messages where the profile is the recipient.

Parameters:

Profile profile Required parameter.

Returns: SystemDataView

DataList Name: MessageInbox

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
transactionId	String
txId	String
txName	String
txDescription	String
txCategory	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String

Since: 01-10-2013

top

SystemDataView getMessages()

Returns all messages associated with this Pal.

Returns: SystemDataView

DataList Name: Messages

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
transactionId	String
txId	String
txName	String
txDescription	String
txCategory	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String

Since: 01-10-2013

top

SystemDataView getMessagesSent(Profile profile)

Returns messages where the profile is the sender.

Parameters:

Profile profile Required parameter.

Returns: SystemDataView

DataList Name: MessagesSent

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
transactionId	String
txId	String
txName	String
txDescription	String
txCategory	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String

Since: 01-10-2013

top

SystemDataView getTransactionMessages(String txId)

Returns messages associated with the transaction.

Parameters:

String txId Required parameter.

Returns: SystemDataView

DataList Name: TransactionMessages

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String

Since: 01-10-2013

top

String toString()

Returns a description of this object.

Returns: String

Since: 01-10-2013

top

API Date: Nov 22, 2024 11:54 AM