com.tridion.linking.events

Interface PageLinkListener

All Superinterfaces:

LinkListener

All Known Implementing Classes:

Linking

public interface PageLinkListener
extends LinkListener

Implement this interface to enable link resolution tracking in external software.

Method Summary

Modifier and Type	Method and Description
void	pageLinkNotification(int publicationId, int targetPageId, String anchor, String linkTagAttributes, String linkText, boolean showTextOnFail, String parameters, Link returnLink) Implement this method to process the parameters passed.

Methods inherited from interface com.tridion.linking.events.LinkListener

configure

Method Detail

pageLinkNotification

void pageLinkNotification(int publicationId,
                          int targetPageId,
                          String anchor,
                          String linkTagAttributes,
                          String linkText,
                          boolean showTextOnFail,
                          String parameters,
                          Link returnLink)

Implement this method to process the parameters passed. Then configure the PageLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all PageLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Parameters:

publicationId - The Id of the publication which the page the link is trying to resolve to is in.

targetPageId - The Id of the page the link is trying to resolve to.

anchor - The anchor on the page where the link has to be pointing to.

linkTagAttributes - Attributes to include in the link.

linkText - The text to be displayed for the link.

showTextOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

parameters - HTTP parameters to be appended to the URL.

returnLink - The Link resolved by the PageLink class.