Back to index

plone3  3.1.7
Public Member Functions
plone.app.portlets.portlets.rss.IFeed Class Reference
Inheritance diagram for plone.app.portlets.portlets.rss.IFeed:
Inheritance graph
[legend]
Collaboration diagram for plone.app.portlets.portlets.rss.IFeed:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def loaded
def title
def items
def feed_link
def site_url
def last_update_time_in_minutes
def last_update_time
def needs_update
def update
def update_failed
def ok

Detailed Description

Definition at line 27 of file rss.py.


Constructor & Destructor Documentation

def plone.app.portlets.portlets.rss.IFeed.__init__ (   url,
  timeout 
)
initialize the feed with the given url. will not automatically load it
   timeout defines the time between updates in minutes        

Definition at line 29 of file rss.py.

00029 
00030     def __init__(url, timeout):
00031         """initialize the feed with the given url. will not automatically load it
00032            timeout defines the time between updates in minutes        
00033         """
        

Here is the caller graph for this function:


Member Function Documentation

return the url of this feed in feed:// format

Definition at line 43 of file rss.py.

00043 
00044     def feed_link():
00045         """return the url of this feed in feed:// format"""
        
return the items of the feed

Definition at line 40 of file rss.py.

00040 
00041     def items():
00042         """return the items of the feed"""
        

Here is the caller graph for this function:

return the time the feed was last updated as DateTime object

Definition at line 52 of file rss.py.

00052 
00053     def last_update_time():
00054         """return the time the feed was last updated as DateTime object"""
    
return the time this feed was last updated in minutes since epoch

Definition at line 49 of file rss.py.

00049 
00050     def last_update_time_in_minutes():
00051         """return the time this feed was last updated in minutes since epoch"""
        

Here is the caller graph for this function:

return if this feed is in a loaded state

Definition at line 34 of file rss.py.

00034 
00035     def loaded():
00036         """return if this feed is in a loaded state"""
        
return if this feed needs to be updated

Definition at line 55 of file rss.py.

00055 
00056     def needs_update():
00057         """return if this feed needs to be updated"""
        

Here is the caller graph for this function:

is this feed ok to display?

Definition at line 66 of file rss.py.

00066 
00067     def ok():
00068         """is this feed ok to display?"""

Here is the caller graph for this function:

return the URL of the site

Definition at line 46 of file rss.py.

00046 
00047     def site_url():
00048         """return the URL of the site"""
    

Here is the caller graph for this function:

return the title of the feed

Definition at line 37 of file rss.py.

00037 
00038     def title():
00039         """return the title of the feed"""

Here is the caller graph for this function:

update this feed. will automatically check failure state etc.
   returns True or False whether it succeeded or not

Definition at line 58 of file rss.py.

00058 
00059     def update():
00060         """update this feed. will automatically check failure state etc.
00061            returns True or False whether it succeeded or not
00062         """
                

Here is the caller graph for this function:

return if the last update failed or not

Definition at line 63 of file rss.py.

00063 
00064     def update_failed():
00065         """return if the last update failed or not"""
        

Here is the caller graph for this function:


The documentation for this class was generated from the following file: