RSS Class
Properties Methods Events Configuration Settings Errors
The RSS Component is used to retrieve, parse, edit, and write RSS syndicated content.
Syntax
RSS
Remarks
The RSS Class implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.
The class 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 class can also generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.
The RSS Class 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 class 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 class with short descriptions. Click on the links for further details.
| Accept | A list of acceptable MIME types for the request. |
| Authorization | The Authorization string to be sent to the server. |
| AuthScheme | The authentication scheme to use when server authorization is required. |
| ChannelCategory | The value of this property is a forward-slash-separated string that identifies a hierarchic location in a particular hierarchy. |
| ChannelCategoryDomain | This property contains the URL indicating the definition of the current RSS channel's category. |
| ChannelCopyright | This property contains the copyright information for the current RSS channel (500 char max). |
| ChannelDescription | This property contains a textual description of the current RSS feed (Required - 500 char max). |
| ChannelDocs | This should contain a URL for the documentation describing what format was used to create the current RSS channel. |
| ChannelGenerator | This property contains the name of the program which created the RSS feed. |
| ChannelImageDescription | This property is used to specify text that is included in the title attribute of the image's link formed in HTML rendering. |
| ChannelImageHeight | This property contains the height of the image in pixels. |
| ChannelImageLink | This property contains the URL associated with the channel's associated image. |
| ChannelImageTitle | This property contains the title of the channel's associated image. |
| ChannelImageUrl | This property contains the URL location of the channel's associated image. |
| ChannelImageWidth | This property contains the width of the image in pixels. |
| ChannelLanguage | This property is required for feeds that conform to version 0. |
| ChannelLastBuildDate | This property contains the date of the current RSS channel's most recent content changes. |
| ChannelLink | This property contains the URL that corresponds to the website where the RSS channel is located (Required - 500 char max). |
| ChannelManagingEditor | This property contains the email address or contact information for the current RSS channel's editor. |
| ChannelPubDate | This property contains the date of the current RSS channel's most recent publication. |
| ChannelSkipDays | This property contains a list of days in which aggregators may skip reading the channel. |
| ChannelSkipHours | This property contains a list of hours in which aggregators may skip reading the channel. |
| ChannelTitle | This property contains the title of the current RSS Feed (Required - 40 char max). |
| ChannelTtl | This property contains a number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source. |
| ChannelWebMaster | This property contains the email address or contact information for the current RSS channel's webmaster. |
| Connected | Shows whether the component is connected. |
| CookieCount | The number of records in the Cookie arrays. |
| CookieDomain | The domain of a received cookie. |
| CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
| CookieName | The name of the cookie. |
| CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
| CookieSecure | This property contains the security flag of the received cookie. |
| CookieValue | This property contains the value of the cookie. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| 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. |
| ItemCount | The number of records in the Item arrays. |
| ItemAuthor | This property contains the email address or contact information for the current item's author. |
| ItemCategory | This property contains the location of the current item within a hierarchy. |
| ItemCategoryDomain | This property contains the URL indicating the definition of the current item's category. |
| ItemComments | If present, this property should point to a URL location of a page for comments related to the current item. |
| ItemDescription | This property contains the description of the content of the current item. |
| ItemEnclosureLength | This property indicates how large the enclosure is in bytes. |
| ItemEnclosureType | This property specifies the type of enclosure. |
| ItemEnclosureUrl | This property contains the URL where the enclosure is located. |
| ItemGuid | This property contains the globally unique identifier for the current item. |
| ItemGuidIsPermaLink | When this property is set to true, the reader may assume that the guid is a permalink to the item. |
| ItemXML | This property contains the full XML contents of the item. |
| ItemLink | For headline or abstract items, this property should be the location of the full text of the item. |
| ItemPubDate | This property contains the date of the current item's most recent publication. |
| ItemSource | This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title. |
| ItemSourceURL | This property contains the URL location of the XML-version of the current item's source. |
| ItemTitle | This property contains the title or headline of the current item. |
| 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. |
| NamespaceCount | The number of records in the Namespace arrays. |
| NamespacePrefix | The Prefix for the Namespace . |
| NamespaceURI | Namespace URI associated with the corresponding Prefix . |
| OtherHeaders | Other headers as determined by the user (optional). |
| ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
| ParsedHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
| ParsedHeaderValue | This property contains the header contents. |
| Password | A password if authentication is to be used. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| Referer | Referer URL/document (optional). |
| RSSData | The complete text of the RSS XML file. |
| RSSVersion | The RSS protocol version of the current RSS feed. |
| Timeout | A timeout for the component. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum of bytes 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 class with short descriptions. Click on the links for further details.
| AddCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
| AddItem | Inserts a new item into the beginning of an RSS feed. |
| AddNamespace | Adds a namespace to the Namespaces properties. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| GetFeed | Fetches an RSS feed. |
| GetProperty | Gets the value of a specific RSS feed item element or attribute. |
| GetURL | Fetches an RSS feed. |
| Interrupt | 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 | Loads an RSS file into the component. |
| ReadOPML | Reads and parses an OPML file. |
| Reset | Resets all properties of the component. |
| SetProperty | Sets the value of a specific RSS feed property. |
| WriteFile | Writes an RSS feed from the component. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| 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 class with short descriptions. Click on the links for further details.
| ItemAdditionalData[i] | Additional data to be added to an RSS Feed item. |
| ValueFormat | Format of data returned or set. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| 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. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| 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. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |