Interface Inx_Api_DataAccess_LinkDataRowSet

Description

An Inx_Api_DataAccess_LinkDataRowSet is used to access rows of link data resulting from a query.

An Inx_Api_DataAccess_LinkDataRowSet is used to access rows of link data resulting from a query. Only tracked links - which can be used for opening analysis - will be fetched. The following data can be retrieved:

  • Link id: the unique identifier of the link.
  • Link name: the name of the link (alias).
  • Link type: the type of the link (see constants below).
  • Link URL: the Uniform resource locator (URL) of the link.
  • Action id: the id of the action associated to this link, if any.
  • Mailing id: the id of the mailing which contains the link.
The link type can be one of the following:
  • LINK_TYPE_REDIRECT - can be used to perform actions before redirecting to the target URL.
  • LINK_TYPE_UNSUBSCRIBE - unsubscribes the current recipient without verification (deprecated).
  • LINK_TYPE_COUNT - tracking link that counts each click.
  • LINK_TYPE_UNIQUE_COUNT - tracking link that counts each click and the first click of every recipient.
  • LINK_TYPE_VERIFY_SUBSCRIPTION - verifies the subscription of the current recipient.
  • LINK_TYPE_VERIFY_UNSUBSCRIPTION - verifies the unsubscription of the current recipient.
  • LINK_TYPE_OPENING_COUNT - trackable image that counts each loading and the first loading for each recipient.
  • LINK_TYPE_CONTENT - tracking link embedded in external content (unique count).
  • LINK_TYPE_OPENING_CONTENT - trackable image embedded in external content (unique count).
  • LINK_TYPE_UNSUBSCRIBE_LINK - unsubscribes the current recipient without verification.
  • LINK_TYPE_HEADER_UNSUBSCRIBE - unsubscribes the current recipient using the header unsubscription. Clients which support this feature (like Google mail) will show an unsubscription button at the head of the mailing.
  • LINK_TYPE_JSP_UNSUBSCRIBE - unsubscribes the current recipient using a JSP landing page.
  • LINK_TYPE_PAGE_UNSUBSCRIBE - unsubscribes the current recipient using a HTML landing page.
  • LINK_TYPE_UNKNOWN - unknown link type used for legacy APIs (server version > API version).
For information on how to navigate through an Inx_Api_DataAccess_LinkDataRowSet, see the Inx_Api_InxRowSet documentation.

For an example on how to query link data, see the Inx_Api_DataAccess_LinkData documentation.

Located in /Api/DataAccess/LinkDataRowSet.php (line 52)

Inx_Api_InxRowSet
   |
   --Inx_Api_DataAccess_DataRowSet
      |
      --Inx_Api_DataAccess_LinkDataRowSet
Class Constant Summary
Method Summary
int getActionId ()
int getLinkId ()
string getLinkName ()
int getLinkType ()
string getLinkUrl ()
int getMailingId ()
boolean isPermanent ()
Methods
getActionId (line 213)

Returns the id of the action associated to this link, or 0 if no action is associated to this link.

Returns the id of the action associated to this link, or 0 if no action is associated to this link.

  • return: the id of the associated action, or 0.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getActionId ()
getLinkId (line 160)

Returns the unique identifier of the current link.

Returns the unique identifier of the current link.

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

Returns the name of the current link.

Returns the name of the current link.

  • return: the name of the current link.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
string getLinkName ()
getLinkType (line 205)

Returns the type of the current link.

Returns the type of the current link. The possible types are:

  • LINK_TYPE_REDIRECT - can be used to perform actions before redirecting to the target URL.
  • LINK_TYPE_UNSUBSCRIBE - unsubscribes the current recipient without verification (deprecated).
  • LINK_TYPE_COUNT - tracking link that counts each click.
  • LINK_TYPE_UNIQUE_COUNT - tracking link that counts each click and the first click of every recipient.
  • LINK_TYPE_VERIFY_SUBSCRIPTION - verifies the subscription of the current recipient.
  • LINK_TYPE_VERIFY_UNSUBSCRIPTION - verifies the unsubscription of the current recipient.
  • LINK_TYPE_OPENING_COUNT - trackable image that counts each loading and the first loading for each recipient.
  • LINK_TYPE_CONTENT - tracking link embedded in external content (unique count).
  • LINK_TYPE_OPENING_CONTENT - trackable image embedded in external content (unique count).
  • LINK_TYPE_UNSUBSCRIBE_LINK - unsubscribes the current recipient without verification.
  • LINK_TYPE_HEADER_UNSUBSCRIBE - unsubscribes the current recipient using the header unsubscription. Clients which support this feature (like Google mail) will show an unsubscription button at the head of the mailing.
  • LINK_TYPE_JSP_UNSUBSCRIBE - unsubscribes the current recipient using a JSP landing page.
  • LINK_TYPE_PAGE_UNSUBSCRIBE - unsubscribes the current recipient using a HTML landing page.
  • LINK_TYPE_UNKNOWN - unknown link type used for legacy APIs (server version > API version).

  • return: the type of the current link.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getLinkType ()
getLinkUrl (line 177)

Returns the uniform resource locator (URL) of the current link.

Returns the uniform resource locator (URL) of the current link.

  • return: the URL of the current link.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
string getLinkUrl ()
getMailingId (line 221)

Returns the id of the mailing which contains the current link.

Returns the id of the mailing which contains the current link.

  • return: the id of the mailing which contains the current link.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
int getMailingId ()
isPermanent (line 230)

Returns whether the current link is permanent.

Returns whether the current link is permanent. Permanent links will not be changed in future. Non permanent links are called temporary and may be changed or deleted.

  • return: true if and only if the current link is permanent, false otherwise (temporary link)
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
  • access: public
boolean isPermanent ()

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
LINK_TYPE_CONTENT = 8 (line 100)

The 'content' link type counts the number of recipients that click a link embedded in external content.

The 'content' link type counts the number of recipients that click a link embedded in external content.

LINK_TYPE_COUNT = 2 (line 72)

The 'count' link type counts each click of a particular link.

The 'count' link type counts each click of a particular link.

LINK_TYPE_HEADER_UNSUBSCRIBE = 11 (line 126)

The 'header unsubscribe' link type unsubscribes the current recipient using the header unsubscription. which support this feature (like Google mail) will show an unsubscription button at the head of the mailing.

The 'header unsubscribe' link type unsubscribes the current recipient using the header unsubscription. Clients which support this feature (like Google mail) will show an unsubscription button at the head of the mailing.

  • since: API 1.8.0
LINK_TYPE_JSP_UNSUBSCRIBE = 12 (line 134)

The 'JSP unsubscribe' link type unsubscribes the current recipient using a JSP landing page.

The 'JSP unsubscribe' link type unsubscribes the current recipient using a JSP landing page.

  • since: API 1.8.0
LINK_TYPE_OPENING_CONTENT = 9 (line 109)

The 'opening content' link type counts the number of recipients that load an image embedded in external content.

The 'opening content' link type counts the number of recipients that load an image embedded in external content.

LINK_TYPE_OPENING_COUNT = 7 (line 92)

The 'opening count' link type counts each loading of a particular image and the first loading for each recipient (tracks the number of recipients for which the image has been loaded).

The 'opening count' link type counts each loading of a particular image and the first loading for each recipient (tracks the number of recipients for which the image has been loaded). Both values can be used for reporting and analysis.

LINK_TYPE_PAGE_UNSUBSCRIBE = 13 (line 142)

The 'page unsubscribe' link type unsubscribes the current recipient using a HTML landing page.

The 'page unsubscribe' link type unsubscribes the current recipient using a HTML landing page.

  • since: API 1.8.0
LINK_TYPE_REDIRECT = 0 (line 56)

The 'redirect' link type can be used to perform actions before redirecting to the target URL.

The 'redirect' link type can be used to perform actions before redirecting to the target URL.

LINK_TYPE_UNIQUE_COUNT = 3 (line 78)

The 'unique count' link type counts each click of a particular link and the first click of a recipient (tracks the number of recipients that clicked the link).

The 'unique count' link type counts each click of a particular link and the first click of a recipient (tracks the number of recipients that clicked the link). Both values can be used for reporting and analysis.

LINK_TYPE_UNKNOWN = -1 (line 151)

The 'unknown' link type is used for legacy APIs (server version > API version). link type is not supported by the API.

The 'unknown' link type is used for legacy APIs (server version > API version). This type will be used if the link type is not supported by the API.

  • since: API 1.8.0
LINK_TYPE_UNSUBSCRIBE = 1 (line 69)

The deprecated 'unsubscribe' link type unsubscribes the current recipient without verification.

The deprecated 'unsubscribe' link type unsubscribes the current recipient without verification.

  • deprecated: the new unsubscription link types are:
    • LINK_TYPE_UNSUBSCRIBE_LINK
    • LINK_TYPE_HEADER_UNSUBSCRIBE
    • LINK_TYPE_JSP_UNSUBSCRIBE
    • LINK_TYPE_PAGE_UNSUBSCRIBE
LINK_TYPE_UNSUBSCRIBE_LINK = 10 (line 117)

The 'unsubscribe link' link type unsubscribes the current recipient without verification.

The 'unsubscribe link' link type unsubscribes the current recipient without verification.

  • since: API 1.8.0
LINK_TYPE_VERIFY_SUBSCRIPTION = 5 (line 81)

The 'verify subscription' link type verifies the subscription of the current recipient.

The 'verify subscription' link type verifies the subscription of the current recipient.

LINK_TYPE_VERIFY_UNSUBSCRIPTION = 6 (line 84)

The 'verify unsubscription' link type verifies the unsubscription of the current recipient.

The 'verify unsubscription' link type verifies the unsubscription of the current recipient.

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