Interface Inx_Api_DataAccess_ClickData

Description

An Inx_Api_DataAccess_ClickData object can be used to retrieve information about a specific click accessible through an Inx_Api_DataAccess_ClickDataRowSet.

An Inx_Api_DataAccess_ClickData object can be used to retrieve information about a specific click accessible through an Inx_Api_DataAccess_ClickDataRowSet. A row set can be obtained using various filters:

  • mailing: selectByMailing(int, RecipientContext, Attribute[])
  • link: selectByLink(int, RecipientContext, Attribute[])
  • link type: only available in fluent query interface
  • recipient: selectByRecipient(int, RecipientContext, Attribute[])
  • recipient and mailing: selectByRecipientAndMailing(int, int, RecipientContext, Attribute[])
  • before, after and between: various methods for selecting a time span are available
  • sending id: only available in fluent query interface
The basic select methods offer variants to filter the result by date. You can search for click data before or after a specific date or between two specific dates.

The following example returns a result set containing click data for the specified mailing and fetches the email address of the recipients:

 $oDataAccess = $oSession->getDataAccess();
 $oClickData = $oDataAccess->getClickData();
 $oRecipientContext = $oSession->createRecipientContext();
 $oEmail = $oRecipientContext->getMetaData()->getEmailAttribute();
 ...
 $oClickDataRowSet = $oClickData->selectByMailing( $iMailingId, $oRecipientContext, array($oEmail) );
API version 1.11.1 allows you to filter by the type of the clicked link and to retrieve all clicks filtered only by date. Offering all possible combinations would have made figuring out which method is the right one a tedious job. Therefore, these filter types are only available using the new fluent style query API. The query API also allows to specify arrays of IDs. The following snippet demonstrates how to filter the clicks by two mailings, two link types and a start date:
 $oDataAccess = $oSession->getDataAccess();
 $oClickData = $oDataAccess->getClickData();
 $oRecipientContext = $oSession->createRecipientContext();
 $oEmail = $oRecipientContext->getMetaData()->getEmailAttribute();

 $aMailingIds = array( 1234, 4711 );
 $aLinkTypes = array( Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_UNIQUE_COUNT,
      Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_OPENING_COUNT );
 $sOneDayAgo = date( 'c', strtotime( '-1 day' ) );
 ...
 $oClickDataQuery = $oClickData->createQuery( $oRecipientContext, array( $oEmail ) );
 $oClickDataRowSet = $oClickDataQuery->mailings( $aMailingIds )->linkTypes( $aLinkTypes )->after( $sOneDayAgo )->executeQuery();
For more information on the data available for clicks, see the Inx_Api_DataAccess_ClickDataRowSet documentation.

Located in /Api/DataAccess/ClickData.php (line 67)


	
			
Method Summary
Inx_Api_DataAccess_ClickDataRowSet selectByLinkAfter (int $iLinkId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByLinkBefore (int $iLinkId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByLinkBetween (int $iLinkId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByMailingAfter (int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByMailingBefore (int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByMailingBetween (int $iMailingId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAfter (int $iRecipientId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailing (int $iRecipientId, int $iMailingId, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingAfter (int $iRecipientId, int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingBefore (int $iRecipientId, int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingBetween (int $iRecipientId, int $iMailingId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientBefore (int $iRecipientId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientBetween (int $iRecipientId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
Methods
createQuery (line 457)

Creates a query object which allows to retrieve clicks using a fluent interface. the clicks by the following criteria:

  • mailing ID(s)
  • link ID(s)
  • recipient ID(s)
  • link type(s)
  • start date
  • end date
All filters can be freely combined.

Creates a query object which allows to retrieve clicks using a fluent interface. Using this object you can filter the clicks by the following criteria:

  • mailing ID(s)
  • link ID(s)
  • recipient ID(s)
  • link type(s)
  • start date
  • end date
All filters can be freely combined. IDs can be given as a single int or as an int[]. The same is true for the link types. This allows the creation of complex queries while the fluent interface keeps the syntax as concise as possible. Important note: The Inxmail Professional server will terminate any ClickDataQuery request that produces an overall result size of over ten million clicks, by default. Any request with a result size above this threshold will result in a server-side RuntimeException.

  • return: a ClickDataQuery object which allows to retrieve clicks using a fluent interface.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.11.1
  • access: public
  • Inx_Api_Recipient_RecipientContext $oRc: the RecipientContext. See Inx_Api_Session::createRecipientContext().
  • array $aAttrs: an array of recipient attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectByLink (line 178)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByLink (int $iLinkId, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iLinkId: the id of the link.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByLinkAfter (line 223)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred after the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByLinkAfter (int $iLinkId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iLinkId: the id of the link.
  • string $dtSearchDate: all clicks after this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByLinkBefore (line 201)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred before the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByLinkBefore (int $iLinkId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iLinkId: the id of the link.
  • string $dtSearchDate: all clicks before this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByLinkBetween (line 247)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred between the specified dates.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified link which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByLinkBetween (int $iLinkId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iLinkId: the id of the link.
  • string $dtStartDate: the start date for the search. The date has to be formatted as ISO 8601 date string.
  • string $dtEndDate: the end date for the search. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByMailing (line 87)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByMailing (int $iMailingId, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iMailingId: the id of the mailing.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByMailingAfter (line 132)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred after the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByMailingAfter (int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iMailingId: the id of the mailing.
  • string $dtSearchDate: all clicks after this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByMailingBefore (line 110)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred before the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByMailingBefore (int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iMailingId: the id of the mailing.
  • string $dtSearchDate: all clicks before this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByMailingBetween (line 157)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred between the specified dates.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified mailing which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByMailingBetween (int $iMailingId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iMailingId: the id of the mailing.
  • string $dtStartDate: the start date for the search. The date has to be formatted as ISO 8601 date string.
  • string $dtEndDate: the end date for the search. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipient (line 266)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipient (int $iRecipientId, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientAfter (line 311)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred after the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAfter (int $iRecipientId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • string $dtSearchDate: all clicks after this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientAndMailing (line 356)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailing (int $iRecipientId, int $iMailingId, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • int $iMailingId: the id of the mailing.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientAndMailingAfter (line 402)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred after the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred after the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingAfter (int $iRecipientId, int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • int $iMailingId: the id of the mailing.
  • string $dtSearchDate: all clicks after this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientAndMailingBefore (line 379)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred before the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingBefore (int $iRecipientId, int $iMailingId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • int $iMailingId: the id of the mailing.
  • string $dtSearchDate: all clicks before this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientAndMailingBetween (line 427)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred between the specified dates.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient and mailing which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientAndMailingBetween (int $iRecipientId, int $iMailingId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • int $iMailingId: the id of the mailing.
  • string $dtStartDate: the start date for the search. The date has to be formatted as ISO 8601 date string.
  • string $dtEndDate: the end date for the search. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientBefore (line 288)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred before the specified date.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred before the specified date. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientBefore (int $iRecipientId, string $dtSearchDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • string $dtSearchDate: all clicks before this date will be selected. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData
selectByRecipientBetween (line 335)

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred between the specified dates.

This method returns an Inx_Api_DataAccess_ClickDataRowSet containing information about all clicks regarding the specified recipient which occurred between the specified dates. If there is no click data, an empty row set will be returned. If the Inx_Api_Recipielt_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved click data will contain information about the recipient state and the specified recipient attributes.

  • return: an Inx_Api_DataAccess_ClickDataRowSet object that contains the data produced by the given query.
  • throws: Inx_Api_NullPointerException if no Inx_Api_Recipient_RecipientContext is provided.
  • since: API 1.6.2
  • access: public
Inx_Api_DataAccess_ClickDataRowSet selectByRecipientBetween (int $iRecipientId, string $dtStartDate, string $dtEndDate, Inx_Api_Recipient_RecipientContext $oRc, [ $aAttrs = null])
  • int $iRecipientId: the id of the recipient.
  • string $dtStartDate: the start date for the search. The date has to be formatted as ISO 8601 date string.
  • string $dtEndDate: the end date for the search. The date has to be formatted as ISO 8601 date string.
  • Inx_Api_Recipient_RecipientContext $oRc: the recipient context. See Inx_Api_Session->createRecipientContext()
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData

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