Module ruya :: Class Crawler :: Class UriIncludeEventArgs

[frames] | no frames]

Class UriIncludeEventArgs

       object --+    
                |    
Crawler.EventArgs --+
                    |
                   Crawler.UriIncludeEventArgs

Ruya's Crawler provides event-based callback mechanism during crawl to allow clients to have more control over which urls are crawled. The events use this object for event communication for includelink event.

Instance Methods

None

__init__(self, level=0, uri=None, args=[])
Returns: None source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables

uri
The Uri to include in crawl.

Inherited from EventArgs

args
Additional arguments to be passed back to event handler.

cancel
Flag that can be set to True by clients to cancel entire crawl process - Use with caution.

ignore
Flag that can be set to True by clients to ignore a url from crawling, and continue next url.

level
Crawl level on which the event was raised.

Properties

Inherited from object: __class__

Method Details

init(self, level=0, uri=None, args=`[]`)
(Constructor)

Constructor.

Parameters:

level (number.) - Crawl level on which the event was raised.
uri (Uri) - The Uri to include in crawl.
args (list) - Additional arguments to be passed back to event handler.

Returns: None

Overrides: EventArgs.__init__