IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

RSS Bean

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Rss

Remarks

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

The bean 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 bean can also generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Bean 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 bean properties. It also supports non-standard properties as specified in the RSS protocol through the Namespaces collection and the GetProperty and SetProperty methods.

Property List


The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.

AcceptA list of acceptable MIME types for the request.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ChannelThe channel data for the 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 bytes 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 bean with short descriptions. Click on the links for further details.

addCookieAdds a cookie and the corresponding value to the outgoing request headers.
addItemInserts 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.
getFeedFetches an RSS feed.
getPropertyGets the value of a specific RSS feed item element or attribute.
getURLFetches 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.
readFileLoads an RSS file into the component.
readOPMLReads and parses an OPML file.
resetResets all properties of the component.
setPropertySets the value of a specific RSS feed property.
writeFileWrites an RSS feed from the component.

Event List


The following is the full list of the events fired by the bean 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 bean with short descriptions. Click on the links for further details.

ItemAdditionalData[i]Additional data to be added to an RSS Feed item.
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.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
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 completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
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.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
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.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0