LinkDataQuery provides a fluent interface for retrieving link data. to filter the links:
LinkDataQuery provides a fluent interface for retrieving link data. The following criteria can be used to filter the links:
Important note: The Inxmail Professional server will terminate any ClickDataQuery request that produces an overall result size of over ten million links, by default. Any request with a result size above this threshold will result in a server-side RuntimeException.
The following snippet demonstrates how simple it is to retrieve all links which are of a certain type and have been clicked by specific members:
$oQuery = session->getDataAccess()->getLinkDataWithNewLinkType()->createQuery(); $oResult = $oQuery->linkTypes(aray(Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_UNIQUE_COUNT))-> recipientIds(array(1001, 1002))->executeQuery();
For more information about link data, see the Inx_Api_DataAccess_LinkData documentation.
Located in /Api/DataAccess/LinkDataQuery.php (line 39)
Executes the query, applying all filters and returning the resulting LinkDataRowSet.
Executes the query, applying all filters and returning the resulting LinkDataRowSet.
Assigns a link filter for links, overwriting any existing link filters. the given link IDs.
Assigns a link filter for links, overwriting any existing link filters. The filter matches all links with the given link IDs. The result will contain the links with the given link IDs. Invalid link IDs will be ignored.
Assigns a link name filter for link names, overwriting any existing link name filters. contains all links where the names (alias) of the link is equal to any given link name. called at all or called with null this filter doesn't apply.
Assigns a link name filter for link names, overwriting any existing link name filters. The result contains all links where the names (alias) of the link is equal to any given link name. If this method is not called at all or called with null this filter doesn't apply.
Assigns a link name set filter for filtering whether link name has a value or is null, overwriting any existing link name set filters. means not null. null.
Assigns a link name set filter for filtering whether link name has a value or is null, overwriting any existing link name set filters. If TRUE, the result only contains links with a set name, which means not null. If FALSE, the result only contains links where the link name is null. If the method is not called at all or called with null this filter doesn't apply.
Assigns a link type filter for link types, overwriting any existing link type filter. contain only links of the given types.
Assigns a link type filter for link types, overwriting any existing link type filter. The result will contain only links of the given types.
Assigns a mailing filter for mailings, overwriting any existing mailing filters. contain links which are part of the given mailings.
Assigns a mailing filter for mailings, overwriting any existing mailing filters. The result will only contain links which are part of the given mailings. Invalid mailing IDs will be ignored.
Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. the result may contain temporary links. only.
Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. If called, the result may contain temporary links. If the method is not called, the result will include permanent links only.
Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. the query result will contain permanent links only.
Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. If called, the query result will contain permanent links only. This is the default behaviour.
Assigns a recipient filter for recipients, overwriting any existing recipient filters. contain all links which have been clicked by at least one of the given recipients. ignored.
Assigns a recipient filter for recipients, overwriting any existing recipient filters. The result will contain all links which have been clicked by at least one of the given recipients. Invalid recipient IDs will be ignored.
Documentation generated on Thu, 17 Sep 2015 14:27:26 +0200 by phpDocumentor 1.3.2