Interface Inx_Api_Sending_IndividualSendingRowSet

Description

The Inx_Api_Sending_IndividualSendingRowSet gives information regarding the reaction of recipients to sendings.

The Inx_Api_Sending_IndividualSendingRowSet gives information regarding the reaction of recipients to sendings. Use this kind of row set to determine whether a recipient opened a mailing, clicked a link of that mailing or caused a bounce. It is also possible to inspect the state of the sending. It is not possible though, to access recipient meta data (i.e. recipient column data and status) or to manipulate recipients.

Located in /Api/Sending/IndividualSendingRowSet.php (line 18)

Inx_Api_InxRowSet
   |
   --Inx_Api_Sending_IndividualSendingRowSet
Direct descendents
Class Description
Inx_Api_Sending_SendingRecipientRowSet The Inx_Api_Sending_SendingRecipientRowSet gives information regarding the reaction of recipients to sendings.
Method Summary
Methods
getRecipientId (line 27)

Returns the ID of the recipient.

Returns the ID of the recipient.

  • return: The ID of the recipient.
  • throws: Inx_Api_DataException if no row is selected (i.e. you forgot to call next()).
  • access: public
int getRecipientId ()
getState (line 60)

Returns the state of the sending to the currently selected recipient.

Returns the state of the sending to the currently selected recipient.

  • return: The state of the sending to the currently selected recipient.
  • throws: Inx_Api_DataException if no row is selected (i.e. you forgot to call next()).
  • access: public
hasBounced (line 35)

Returns a bool indicating whether the currently selected recipient caused a bounce.

Returns a bool indicating whether the currently selected recipient caused a bounce.

  • return: true if the currently selected recipient caused a bounce, false otherwise.
  • throws: Inx_Api_DataException if no row is selected (i.e. you forgot to call next()).
  • access: public
bool hasBounced ()
hasClicked (line 52)

Returns a bool indicating whether the currently selected recipient clicked any link of the mail.

Returns a bool indicating whether the currently selected recipient clicked any link of the mail.

  • return: true if the currently selected recipient clicked any link of the mail, false otherwise.
  • throws: Inx_Api_DataException if no row is selected (i.e. you forgot to call next()).
  • access: public
bool hasClicked ()
hasOpened (line 43)

Returns a bool indicating whether the currently selected recipient opened the mail.

Returns a bool indicating whether the currently selected recipient opened the mail.

  • return: true if the currently selected recipient opened the mail, false otherwise.
  • throws: Inx_Api_DataException if no row is selected (i.e. you forgot to call next()).
  • access: public
bool hasOpened ()

Inherited Methods

Inherited From Inx_Api_InxRowSet

Inx_Api_InxRowSet::afterLastRow()
Inx_Api_InxRowSet::beforeFirstRow()
Inx_Api_InxRowSet::close()
Inx_Api_InxRowSet::getRow()
Inx_Api_InxRowSet::getRowCount()
Inx_Api_InxRowSet::next()
Inx_Api_InxRowSet::previous()
Inx_Api_InxRowSet::setRow()

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