com.tridion.linking.events

Interface BinaryLinkListener

All Superinterfaces:

LinkListener

All Known Implementing Classes:

Linking

public interface BinaryLinkListener
extends LinkListener

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

Method Summary

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

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

configure

Method Detail

binaryLinkNotification

void binaryLinkNotification(int publicationId,
                            int targetComponentId,
                            String anchor,
                            String linkText,
                            String linkTagAttributes,
                            boolean showTextOnFail,
                            String mimeType,
                            boolean isComponent,
                            Link returnLink)

Implement this method to process the parameters passed. Then configure the BinaryLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all BinaryLinks 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 Binary the link is trying to resolve to is in.

targetComponentId - The Id of the Binary Component to link to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The text to be displayed for the link.

linkTagAttributes - Optional query that should be placed in the anchor.

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

mimeType - The MIME type of the Binary.

isComponent - Whether this component is a MultiMedia component in the Management System.

returnLink - The Link resolved by the BinaryLink class.