FeedEntry Class Methods
In this section, the FeedEntry class methods are presented in alphabetical order.
Syntax
addCategory(category)
Description
Use this method to add a category attribute to the feed entry as a string.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| category |
Specifies the category as a string. |
Returns
A Boolean value: True if the add was successful, False otherwise.
Syntax
addContributor(name, email)
Description
Use this method to add a contributor attribute to the feed entry.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| name |
Specifies the name of the contributor as a string. |
|
Specifies the email address for the contributor as a string. |
Returns
A Boolean value: True if the add was successful, False otherwise.
Syntax
addEnclosure(URL, type, length)
Description
Use this method to add an enclosure attribute to the feed entry.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| URL |
Specifies the URL for the enclosure as a string. |
| type |
Specifies the type of the enclosure as a string. |
| length |
Specifies the length for the enclosure in bytes as a number. |
Returns
A Boolean value: True if the add was successful, False otherwise.
Syntax
delete()
Description
Use this method to delete the feed entry from a feed document.
Parameters
None.
Returns
None.
Example
Local boolean &deleted = False;
Local PTFP_FEED:UTILITY:Collection &Entries = %This.Entries;
Local PTFP_FEED:XML_FEED:FeedEntry &thisEntry = %This.getEntry(&pId);
If (&thisEntry <> Null) And
( Not &Entries.Immutable) Then
&deleted = &Entries.deleteById(&pId);
If &deleted Then
&thisEntry.delete();
End-If;
End-If;Syntax
deleteCategory(category)
Description
Use this method to delete a category attribute from a FeedEntry object.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| category |
Specifies the category as a string. |
Returns
A Boolean value: True if the delete was successful, False otherwise.
Syntax
deleteContributor(name)
Description
Use this method to delete a contributor attribute from a feed entry.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| name |
Specifies the name of the contributor as a string. |
Returns
A Boolean value: True if the delete was successful, False otherwise.
Syntax
deleteEnclosure(URL)
Description
Use this method to delete an enclosure attribute from a feed entry.
Note: This is an abstract method.
Parameters
|
Field or Control |
Definition |
|---|---|
| URL |
Specifies the URL for the enclosure as a string. |
Returns
A Boolean value: True if the delete was successful, False otherwise.
Syntax
equals(&Object)
Description
Use this method to evaluate the equivalency of an object with the current feed entry. Equivalency is established based on the value of two properties: the object's ID and the ObjectType.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Object |
Specifies the object to be compared to the current FeedEntry object. |
Returns
A Boolean value: True if the objects are equivalent, False otherwise.