Feed Class Properties
In this section, the Feed class properties are presented in alphabetical order.
Description
This property returns a Boolean value indicating whether the current user is authorized to view the feed definition.
This property is read-only.
Example
import PTFP_FEED:FeedFactory;
import PTFP_FEED:Feed;
Local boolean &succeed;
Local PTFP_FEED:FeedFactory &thisFeedFactory = create PTFP_FEED:FeedFactory();
Local PTFP_FEED:Feed &thisFeed = &thisFeedFactory.getFeed("feed_ID", &thisFeedFactory.Utility.OPERATINGMODE_DELETION);
If &thisFeed <> Null And
&thisFeed.Authorized Then
&succeed = &thisFeed.delete();
End-If;
Description
Use this property to set or return the category ID for the feed definition as a string.
This property is read/write.
Description
This property returns the date and time the feed definition was created as a DateTime value.
This property is read-only.
Description
Use this property to set or return the node on which the feed definition was created, as a string.
This property is read/write.
Description
This property returns user ID of the user who created the feed definition, as a string.
This property is read-only.
Description
Use this property to set or return the portal on which the feed definition was created, as a string.
This property is read/write.
Description
Use this property to set or return a DataSource object for the feed definition.
This property is read/write.
Description
This property returns the data type ID for the feed definition's data source, as a string.
This property is read-only.
Description
Use this property to set or return the description of the feed definition as a string.
This property is read/write.
Description
Use this property to set or return a FeedAttributes collection.
This property is read/write.
Description
Use this property to set or return the user ID to be used to execute the Feed object, as a string. This value overrides the current user ID depending on the authorization type.
This property is read/write.
Description
Use this property to set or return the password to be used to execute the Feed object, as a string. This value overrides the password for the current user ID depending on the authorization type.
This property is read/write.
Description
Use this property to set or return the authorization type to be used to execute the Feed object, as a string. This value overrides the current authorization type. The values are:
|
Value |
Description |
|---|---|
|
&utility.FEEDAUTHTYPE_DEFAULT |
The current authenticated user is used to execute the Feed object. |
|
&utility.FEEDAUTHTYPE_ANONYMOUS |
The specified user is used to execute the Feed object for anonymous requests. |
|
&utility.FEEDAUTHTYPE_ALL |
The specified user is used to execute the Feed object for all requests. |
This property is read/write.
Description
This property is not used currently.
This property is read/write.
Description
This property is not used currently.
This property is read/write.
Description
This property returns a string representing the content URL to open the content page of the feed.
This property is read-only.
Description
Use this property to set or return the FeedFactory object used by this Feed object.
This property is read/write.
Description
Use this property to set or return the feed format as a string. The values are:
|
Value |
Description |
|---|---|
|
&utility.FEEDFORMAT_ATOM10 |
Specifies the Atom 1.0 format. |
This property is read/write.
Description
Use this property to set or return a FeedSecurities collection.
This property is read/write.
Description
Use this property to set or return the security type for the feed as a string. The values are
|
Value |
Description |
|---|---|
|
&utility.FEEDSECUTYPE_PUBLIC |
Specifies public access to the feed. |
|
&utility.FEEDSECUTYPE_SELECTED |
Specifies role or permission list based access to the feed. The role or permission list is stored with the feed definition |
|
&utility.FEEDSECUTYPE_REALTIME |
Specifies real-time security in which the DataSource object is used to validate user access when the feed is requested. |
This property is read/write.
Description
Use this property to set or return a Boolean value indicating whether the current feed definition is a feed template definition.
This property is read/write.
Description
This property returns a string representing the feed URL to open the feed document.
This property is read-only.
Description
This property returns a Boolean value indicating whether the feed definition has administrator-specified data source parameters.
This property is read-only.
Description
This property returns a Boolean value indicating whether the feed definition has user-specified data source parameters.
This property is read-only.
Description
Use this property to set or return a string representing the Integration Broker service operation name that handles requests for this feed.
This property is read/write.
Description
This property returns the ID for the feed definition as a string.
This property is read-only.
Description
This property returns the DateTime value at which the data source's execute method was called to publish feed messages to the Integration Broker queues—that is, the last publication date and time for the feed. The initial value for this property is set to 01-01-1900 12:00AM.
This property is not valid for real-time feeds or for scheduled, generic Integration Broker feeds. It is updated for all other types of scheduled feeds.
This property is read-only.
Description
This property returns the last update date and time for the feed definition, as a DateTime value.
This property is read-only.
Description
This property returns the user ID of the user to have last updated the feed definition, as string.
This property is read-only.
Description
Use this property to set or return the name space ID for the feed definition, as a string. The default name space ID is based on the feed ID as follows: PTFP_node_name_feed_ID.
This property is read/write.
Description
This property returns the object type for the feed definition as a string. For a feed, this is a constant value: Feed.
This property is read-only.
Description
This property returns the operating mode for the Feed object as a number. The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
0 |
&utility.OPERATINGMODE_DEFAULT |
A Feed object in this mode allows all operations such as save, delete, and so on. |
|
10 |
&utility.OPERATINGMODE_EXECUTION |
A Feed object in this mode is for execution to get the feed document. Other operations such as save and delete are not allowed. |
|
11 |
&utility.OPERATINGMODE_EXECUTION_NOENTRY |
A Feed object in this mode is for execution to get a feed document with no feed entries. Otherwise, this mode is the same as the OPERATINGMODE_EXECUTION mode. |
|
100 |
&utility.OPERATINGMODE_AUTHORIZATION |
A Feed object in this mode is for validating user access to the feed. Most other operations such as execute, save, and delete are not allowed. |
|
1000 |
&utility.OPERATINGMODE_DELETION |
A Feed object in this mode is to delete the feed definition. Most other operations such as execute and save are not allowed. |
This property is read-only.
Description
Use this property to set or return object owner ID as a string. For example, for delivered feed definitions, the owner ID is set to PT, CPA, and so on.
This property is read/write.
Description
This property returns the list of sites in which this feed has been published as an array of string.
This property is read-only.
Description
Use this property to set or return the title of the feed definition as a string.
This property is read/write.
Description
Use this property to set or return the Utility object used by the Feed object.
This property is read/write.
Example
import PTFP_FEED:FeedFactory;
import PTFP_FEED:Feed;
import PTFP_FEED:UTILITY:Utility;
Local PTFP_FEED:FeedFactory &thisFeedFactory = create PTFP_FEED:FeedFactory();
Local PTFP_FEED:Feed &thisFeed = &thisFeedFactory.getFeed("feed_ID", &thisFeedFactory.Utility.OPERATINGMODE_DEFAULT);
Local PTFP_FEED:UTILITY:Utility &utility;
If &thisFeed <> Null Then
&utility = &thisFeed.Utility;
End-If;