Search: 
Available in: IP*WORKS! | SSH | SSL
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 further details.

AcceptA list of acceptable MIME types for the request.
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
ChannelThe channel of an rss feed.
ConnectedShows whether the component is connected.
CookiesCollection of cookies.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
IfModifiedSinceA date determining the maximum age of the desired document.
ItemsA collection of items in the current RSS feed.
LocalFileThe path to a local file for downloading. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NamespacesA collection of namespaces in the current namespace stack.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeadersCollection of headers returned from the last request.
PasswordA password if authentication is to be used.
ProxyA set of properties related to proxy access.
RefererReferer URL/document (optional).
RSSDataThe complete text of the RSS XML file.
RSSVersionThe RSS protocol version of the current RSS feed.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
UserA 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 further details.

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AddItemInsert a new item into the beginning of an RSS feed.
AddNamespaceAdds a namespace to the Namespaces properties .
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetFeedFetch an RSS feed.
GetPropertyGet the value of a specific RSS feed item element or attribute.
GetURLFetch an RSS feed.
InterruptInterrupt the current method.
OPMLAttrReturns the value of the attribute specified in the parameter.
PutSends data to the HTTP server using the HTTP PUT method.
ReadFileLoad an RSS file into the component.
ReadOPMLRead and parse an OPML file.
ResetReset all properties of the component.
SetPropertySet the value of a specific RSS feed property.
WriteFileWrite 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 further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
OPMLHeaderFired for each value in the Header section of the current OPML document.
OPMLOutlineFired for each outline in the current OPML document.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired 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 further details.

MaxItemsInstructs component to save the amount of specified that are parsed from the rss feed.
ValueFormatFormat of data returned or set
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AuthorizationThe Authorization string to be sent to the server.
EncodeURLIf set to true the URL will be encoded by the component.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after the completion of the request.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
UserAgentInformation about the user agent (browser).
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
TcpNoDelayWhether or not to delay when sending packets
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only).

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