Interface Inx_Api_Approval_Approver

Description

An Inx_Api_Approval_Approver represents a person that has to approve a mailing before it can be sent.

An Inx_Api_Approval_Approver represents a person that has to approve a mailing before it can be sent. Note: The system wide approvers are only assigned to the system list. Therefore, the system list id is the only id in the array returned by getLists().

Note: In order to commit changes, all attributes enlisted in this class must be assigned a non null value.

Note: The usage of Inx_Api_Approval_Approvers requires the api user right: Inx_Api_UserRights::PROPERTY_SYSTEM_USE

For an example on how to use approvers, see the Inx_Api_Approval_ApproverManager documentation.

Located in /Api/Approval/Approver.php (line 24)

Inx_Api_BusinessObject
   |
   --Inx_Api_Approval_Approver
Method Summary
string getComment ()
string getEmail ()
array getLists ()
string getName ()
void updateComment (string $sComment)
void updateEmail (string $sEmail)
void updateLists (array $lists)
void updateName (string $sName)
Methods
getComment (line 64)

Returns the comment of the approver.

Returns the comment of the approver.

  • return: the comment of the approver.
  • access: public
string getComment ()
getEmail (line 48)

Returns the email address of the approver.

Returns the email address of the approver.

  • return: the email address of the approver.
  • access: public
string getEmail ()
getLists (line 83)

Returns an id list of all lists the approver is assigned to.

Returns an id list of all lists the approver is assigned to. Note: System wide approvers return only the system list id.

  • return: an id list of all lists the approver is assigned to, or the system list id if the approver is assigned to all lists.
  • access: public
array getLists ()
getName (line 32)

Returns the name of the approver.

Returns the name of the approver.

  • return: the name of the approver.
  • access: public
string getName ()
updateComment (line 72)

Sets a new comment for the approver.

Sets a new comment for the approver.

  • access: public
void updateComment (string $sComment)
  • string $sComment: the new comment of the approver.
updateEmail (line 56)

Sets a new email address for the approver.

Sets a new email address for the approver.

  • access: public
void updateEmail (string $sEmail)
  • string $sEmail: the new email address of the approver.
updateLists (line 98)

Sets the lists this approver is assigned to.

Sets the lists this approver is assigned to. Note: Use the id of the system list as the only id in the array if the approver should be assigned to all lists. The following snippet retrieves the system list id:

 $oListContextManager = $oSession->getListContextManager();
 $oListContext = $oListContextManager->findByName( Inx_Api_List_SystemListContext::NAME );

  • access: public
void updateLists (array $lists)
  • array $lists: array of list ids.
updateName (line 40)

Sets a new for the approver.

Sets a new for the approver.

  • access: public
void updateName (string $sName)
  • string $sName: the new name of the approver.

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()

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