Interface Inx_Api_DataAccess_ClickDataRowSet

Description

An Inx_Api_DataAccess_ClickDataRowSet is used to access rows of click data resulting from a query.

An Inx_Api_DataAccess_ClickDataRowSet is used to access rows of click data resulting from a query. The following data can be retrieved:

  • Click id: the unique identifier of the click.
  • Link id: which link was clicked?
  • Recipient id: which recipient clicked the link?
  • Click date: when did the click occur?
  • User agent: which user agent was used by the recipient?
  • Remote host: the recipient's host address.
  • Recipient data: various data about the recipient (like state or attributes).
  • Sending id: which is the associated sending id?
  • Sending: which is the associated sending?
The recipient state can be one of the following:
  • RECIPIENT_STATE_UNKNOWN - if the click is anonymous or no attributes are queried.
  • RECIPIENT_STATE_EXISTENT - if the recipient exists.
  • RECIPIENT_STATE_DELETED - if the recipient was deleted.
For information on how to navigate through an Inx_Api_DataAccess_ClickDataRowSet, see the Inx_Api_InxRowSet documentation. For information on how to retrieve recipient meta data, see the Inx_Api_Recipient_ReadOnlyRecipientRowSet documentation.

For an example on how to query click data, see the Inx_Api_DataAccess_ClickData documentation.

Located in /Api/DataAccess/ClickDataRowSet.php (line 42)

Inx_Api_InxRowSet
   |
   --Inx_Api_DataAccess_DataRowSet
      |
      --Inx_Api_DataAccess_ClickDataRowSet
Class Constant Summary
Method Summary
Methods
getClickId (line 64)

Returns the unique identifier for the current click.

Returns the unique identifier for the current click.

  • return: the id of the current click.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getClickId ()
getClickTimestamp (line 73)

Returns the timestamp (date) when the current click occurred.

Returns the timestamp (date) when the current click occurred.

  • return: the timestamp (date) of the current click. The date will be returned as ISO 8601 formatted date string.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
string getClickTimestamp ()
getLinkId (line 99)

Returns the id of the link which was clicked.

Returns the id of the link which was clicked.

  • return: the link id of the current click.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getLinkId ()
getRecipientId (line 107)

Returns the id of the recipient who performed the current click.

Returns the id of the recipient who performed the current click.

  • return: the recipient id of the current click.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getRecipientId ()
getRecipientState (line 121)

Returns the state of the recipient who performed the current click.

Returns the state of the recipient who performed the current click. The possible recipient states are:

  • RECIPIENT_STATE_UNKNOWN - if the click is anonymous or no attributes are queried.
  • RECIPIENT_STATE_EXISTENT - if the recipient exists.
  • RECIPIENT_STATE_DELETED - if the recipient was deleted.

  • return: the recipient state.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getRecipientState ()
getRemoteHost (line 82)

Returns the remote host which triggered the current click.

Returns the remote host which triggered the current click.

  • return: the remote host of the current click.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
string getRemoteHost ()
getSending (line 140)

Returns the sending of this click.

Returns the sending of this click. This method causes a server call.

  • return: the sending
  • throws: DataException
  • since: API 1.12.1
  • access: public
Inx_Api_Sending_Sending getSending ()
getSendingId (line 130)

Returns the id of the sending associated with this click.

Returns the id of the sending associated with this click.

  • return: the id of the sending associated with this click.
  • throws: DataException
  • since: API 1.12.1
  • access: public
int getSendingId ()
getUserAgent (line 90)

Returns the user agent which was used for the current click.

Returns the user agent which was used for the current click.

  • return: the user agent of the current click.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
string getUserAgent ()

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()
Class Constants
RECIPIENT_STATE_DELETED = 2 (line 55)

State for non existing (deleted) recipient.

State for non existing (deleted) recipient.

RECIPIENT_STATE_EXISTENT = 1 (line 52)

State for existent recipient.

State for existent recipient.

RECIPIENT_STATE_UNKNOWN = 0 (line 49)

State for missing recipient information. and/or no attributes are specified in the query or in case of an unknown recipient.

State for missing recipient information. This state will be used when no Inx_Api_Recipient_RecipientContext and/or no attributes are specified in the query or in case of an unknown recipient.

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