getRelativePageLinkForFeed method: FeedFactory class

Syntax

getRelativePageLinkForFeed(feed_ID, currentFeedURL, linkOption, fromDTTM)

Description

Use this method to get the specified relative paged feed URL (first, previous, next or last) for the current paged feed URL.

This method returns a paged feed URL as a string.

Note:

This method is supported for scheduled feeds only.

Parameters

Parameter Description

feed_ID

Specifies the ID for the scheduled feed definition as a string.

currentFeedURL

Specifies the paged feed URL for the current page as a string.

linkOption

Specifies which page link as a string. See the values below.

fromDTTM

Specifies the start date and time as a DateTime value.
Value Description

&utlity.LINKTYPE_FIRST

Indicates the first page of the paged feed.

&utlity.LINKTYPE_PREVIOUS

Indicates the previous page of the paged feed.

&utlity.LINKTYPE_NEXT

Indicates the next page of the paged feed.

&utlity.LINKTYPE_LAST

Indicates the last page of the paged feed.

Returns

A string.

Example

import PTFP_FEED:FeedFactory;
import PTFP_FEED:UTILITY:Utility;
import PTFP_FEED:UTILITY:Link;

Local PTFP_FEED:FeedFactory &feedFactory_inst;
Local PTFP_FEED:UTILITY:Utility &utility;
Local PTFP_FEED:UTILITY:Link &link;

Local datetime &fromDttm;
Local string &feedLink, &nextFeedLink, &prevFeedLink, &firstFeedLink, ⇒
&lastFeedLink;

&feedFactory_inst = create PTFP_FEED:FeedFactory();
&utility = &feedFactory_inst.Utility;
&fromDttm = DateTimeValue("01/01/1900 00:00:00");
&link = &feedFactory_inst.getFeedLink("ADMN_USER_PROFILE");
If All(&link) Then
   &feedLink = &link.Href;
   &nextFeedLink = &feedFactory_inst.getRelativePageLinkForFeed⇒
("ADMN_USER_PROFILE", &feedLink, &utility.LINKTYPE_NEXT, &fromDttm);
   &prevFeedLink = &feedFactory_inst.getRelativePageLinkForFeed⇒
("ADMN_USER_PROFILE", &feedLink, &utility.LINKTYPE_PREVIOUS, &fromDttm);
   &firstFeedLink = &feedFactory_inst.getRelativePageLinkForFeed⇒
("ADMN_USER_PROFILE", &feedLink, &utility.LINKTYPE_FIRST, &fromDttm);
   &lastFeedLink = &feedFactory_inst.getRelativePageLinkForFeed⇒
("ADMN_USER_PROFILE", &feedLink, &utility.LINKTYPE_LAST, &fromDttm);
End-If;

Related Topics