MigratoryData Client API for PHP
Developer's Guide and Reference Manual
MigratoryDataMessage Class Reference

Represent a message. More...

Public Member Functions

 MigratoryDataMessage (String subject, String content, List< MigratoryDataField > fields)
 Create a MigratoryDataMessage object. More...
 
String getSubject ()
 Get the subject of the message. More...
 
String getContent ()
 Get the content of the message. More...
 
List< MigratoryDataFieldgetFields ()
 Get the fields of the message. More...
 

Detailed Description

Represent a message.

Constructor & Destructor Documentation

MigratoryDataMessage.MigratoryDataMessage ( String  subject,
String  content,
List< MigratoryDataField fields 
)

Create a MigratoryDataMessage object.

Parameters
subjectThe subject of the message
contentThe content of the message
fieldsThe fields of the message (Optional)
Exceptions
MigratoryDataExceptionAn expection with the E_INVALID_SUBJECT code

Member Function Documentation

String MigratoryDataMessage.getSubject ( )

Get the subject of the message.

Returns
A string representing the subject of the message
String MigratoryDataMessage.getContent ( )

Get the content of the message.

Returns
A string representing the content of the message
List<MigratoryDataField> MigratoryDataMessage.getFields ( )

Get the fields of the message.

Returns
The fields of the message as a list of MigratoryDataField objects