Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: IP*WORKS! | SSH | SSL
Rss Class
RSS Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The RSS component is used to retrieve, parse, and write RSS syndicated content.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The RSS component implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The component contains a number of properties that map directly to RSS fields. To receive a feed call the GetFeed method with the URL or file to retrieve specified in the URL parameter. The RSS component can also generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS component supports all RSS feed properties that are standard in versions 0.91, 0.92 and 2.0 of the RSS protocol through a number of component properties. It also supports non-standard properties as specified in the RSS protocol through the Namespaces properties and the GetProperty and SetProperty methods.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

Accept A list of acceptable MIME types for the request.
AuthScheme The authorization scheme to be used when server authorization is to be performed.
Channel The channel of an rss feed.
Connected Shows whether the component is connected.
Cookies Collection of cookies.
Firewall A set of properties related to firewall access.
FollowRedirects Determines what happens when the server issues a redirect.
Idle The current status of the component.
IfModifiedSince A date determining the maximum age of the desired document.
Items A collection of items in the current RSS feed.
LocalFile The path to a local file for downloading. If the file exists, it is overwritten.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Namespaces A collection of namespaces in the current namespace stack.
OtherHeaders Other headers as determined by the user (optional).
ParsedHeaders Collection of headers returned from the last request.
Password A password if authentication is to be used.
Proxy A set of properties related to proxy access.
RSSData The complete text of the RSS XML file.
RSSVersion The RSS protocol version of the current RSS feed.
Referer Referer URL/document (optional).
Timeout A timeout for the component.
TransferredData The contents of the last response from the server.
TransferredDataLimit The maximum of data to be transferred.
TransferredHeaders The full set of headers as received from the server.
User A user name if authentication is to be used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AddCookie Adds a cookie and the corresponding value to the outgoing request headers.
AddItem Insert a new item into the beginning of an RSS feed.
AddNamespace Adds a namespace to the Namespaces properties .
Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
GetFeed Fetch an RSS feed.
GetProperty Get the value of a specific RSS feed item element or attribute.
GetURL Fetch an RSS feed.
Interrupt Interrupt the current method. Interrupt the current method.
OPMLAttr Returns the value of the attribute specified in the parameter.
Put Sends data to the HTTP server using the HTTP PUT method.
ReadFile Load an RSS file into the component.
ReadOPML Read and parse an OPML file.
Reset Reset all properties of the component.
SetProperty Set the value of a specific RSS feed property.
WriteFile Write an RSS feed from the component.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Connected Fired immediately after a connection completes (or fails).
ConnectionStatus Fired to indicate changes in connection state.
Disconnected Fired when a connection is closed.
EndTransfer Fired when a document finishes transferring.
Error Information about errors during data delivery.
Header Fired every time a header line comes in.
OPMLHeader Fired for each value in the Header section of the current OPML document.
OPMLOutline Fired for each outline in the current OPML document.
Redirect Fired when a redirection is received from the server.
SetCookie Fired for every cookie set by the server.
StartTransfer Fired when a document starts transferring (after the headers).
Status Fired when the HTTP status line is received from the server.
Transfer Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression This property enables HTTP compression for receiving data.
Authorization The Authorization string to be sent to the server.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
EncodeURL If set to true the URL will be encoded by the component.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
GetOn302Redirect If set to true the component will perform a GET on the new location.
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxHTTPCookies Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxItems Instructs component to save the amount of specified that are parsed from the rss feed.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme The authorization scheme to be used for the proxy.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if authentication is to be used for the proxy.
TcpNoDelay Whether or not to delay when sending packets
TransferredDataLimit The maximum number of incoming bytes to be stored by the component.
UserAgent Information about the user agent (browser).
ValueFormat Format of data returned or set

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.