Interface Inx_Api_BusinessObject

Description

The API gives access to objects of Inxmail, which are called "BusinessObjects".

The API gives access to objects of Inxmail, which are called "BusinessObjects". For example, a mailing lists in Inxmail is such a Business Object. Values of Inx_Api_BusinessObjects can be changed with the "update" methods (like updateName()). By calling commitUpdate() on such an object, changes will be passed to the server. Rollback is done by the reload() method, which reloads the object and discards all uncomitted changes.

Located in /Api/BusinessObject.php (line 18)


	
			
Direct descendents
Class Description
Inx_Api_Action_Action An Inx_Api_Action_Action is a powerful tool which can manipulate or send a mail to a recipient for which an event has occurred. when the event occurs. for example, be configured to respond automatically to flame mails.
Inx_Api_Approval_Approver An Inx_Api_Approval_Approver represents a person that has to approve a mailing before it can be sent.
Inx_Api_Blacklist_BlacklistEntry An Inx_Api_Blacklist_BlacklistEntry can block individual addresses or complete address ranges so they can not be added to the Inxmail recipient list, neither by import nor by subscription or in any other ways.
Inx_Api_Bounce_Bounce An Inx_Api_Bounce_Bounce object contains information related to a bounce.
Inx_Api_DesignTemplate_DesignCollection An Inx_Api_DesignTemplate_DesignCollection represents a set of templates which are stored in an itc file.
Inx_Api_Filter_Filter An Inx_Api_Filter_Filter is used to define target groups of recipients that share common properties.
Inx_Api_Inbox_InboxMessage An Inx_Api_Inbox_InboxMessage object contains information related to a message received through the inbox.
Inx_Api_List_ListContext An Inx_Api_List_ListContext corresponds to a list in Inxmail, like a mailing list or the system list.
Inx_Api_Mailing_Mailing An Inx_Api_Mailing_Mailing object represents a mailing in inxmail.
Inx_Api_MailingTemplate_MailingTemplate An Inx_Api_MailingTemplate_MailingTemplate represents reusable mailing content that can be used as a basis for new mailings.
Inx_Api_Property_Property Mailing lists have properties, which control the list behaviour.
Inx_Api_Resource_Resource An Inx_Api_Resource_Resource is a business object representing an attachment or an embedded image stored on the server.
Inx_Api_SplitTest_SplitTest A Inx_Api_SplitTest_SplitTest object represents a split test in Inxmail. corresponding split test name.
Inx_Api_SplitTestMailing_SplitTestMailing A Inx_Api_SplitTestMailing_SplitTestMailing object represents a split test mailing in Inxmail. attributes and also the corresponding split test id.
Inx_Api_TextModule_TextModule This class defines a text module.
Inx_Api_Transformation_Transformation This class defines a transformation.
Inx_Api_TriggerMailing_TriggerMailing An Inx_Api_TriggerMailing_TriggerMailing is a special kind of mailing introduced with Inxmail Professional 4.
Inx_Api_Webpage_Webpage An Inx_Api_Webpage_Webpage object can be used to access information about a web page.
Method Summary
void commitUpdate ()
int getId ()
void reload ()
Methods
commitUpdate (line 35)

Passes all changes made since the last commit to the server.

Passes all changes made since the last commit to the server.

  • throws: Inx_Api_DataException if this business object could not be found on the server (e.g. the object was deleted).
  • throws: Inx_Api_UpdateException if the update failed (e.g. one of the attributes is illegal).
  • access: public
void commitUpdate ()
getId (line 26)

Returns the unique identifier of this Inx_Api_BusinessObject.

Returns the unique identifier of this Inx_Api_BusinessObject.

  • return: the unique identifier.
  • access: public
int getId ()
reload (line 43)

Reloads this business object from the server.

Reloads this business object from the server. All changes uncomitted changes are lost.

  • throws: Inx_Api_DataException if this business object could not be found on the server (e.g. the object was deleted).
  • access: public
void reload ()

Documentation generated on Thu, 17 Sep 2015 14:27:22 +0200 by phpDocumentor 1.3.2