Atom Control
Properties Methods Events Configuration Settings Errors
The Atom Component is used to retrieve, parse, and update Atom content.
Syntax
Atom
Remarks
The Atom Control implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).
The control contains a number of properties that map directly to Atom fields. To receive a feed, call the GetFeed method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries properties using the Put method.
The Atom Control supports all standard Atom properties and allows you to add your own through AddNamespace and the GetProperty and SetProperty methods.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| Accept | A list of acceptable MIME types for the request. |
| AtomData | The complete content of the Atom resource. |
| Authorization | The Authorization string to be sent to the server. |
| AuthScheme | The authentication scheme to use when server authorization is required. |
| ChannelAuthorEmail | This property contains the email address of the author. |
| ChannelAuthorName | This property contains the name of the author. |
| ChannelAuthorUri | This property contains the URI of the author. |
| ChannelCategoryLabel | This property contains a textual description of the label for the category. |
| ChannelCategoryScheme | This property identifies a categorization scheme. |
| ChannelCategoryTerm | This property contains the category to which the entry or feed belongs. |
| ChannelContributorEmail | This property contains the email address of the contributor. |
| ChannelContributorName | This property contains the name of the contributor. |
| ChannelContributorUri | This property contains the URI of the contributor. |
| ChannelGenerator | This property identifies the generator of the feed. |
| ChannelIcon | This property contains a reference to the image that represents this feed. |
| ChannelId | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| ChannelLinkHref | This property contains the location of the link. |
| ChannelLinkHrefLang | This property contains the language of the content at the link. |
| ChannelLinkLength | This property contains the length (in bytes) of the content at the link. |
| ChannelLinkRel | This property indicates the relation of the linked content to the feed. |
| ChannelLinkTitle | This property contains the title of the link. |
| ChannelLinkType | This property contains the MIME type of the content at the link. |
| ChannelLogo | This property contains logo for an image that represents the feed. |
| ChannelRights | This property contains information about the rights of the given feed. |
| ChannelRightsTextType | Text type of the rights of the feed. |
| ChannelSubtitle | This contains a short description of the Atom Feed. |
| ChannelSubtitleTextType | This property contains the text type of the sub-title of the feed. |
| ChannelTitle | This property contains the title of the current Atom Feed. |
| ChannelTitleTextType | This property contains the text type of the title of the feed. |
| ChannelUpdated | This property contains the date and time that the feed was updated. |
| Connected | Shows whether the component is connected. |
| ContentType | Content type for posts and puts. |
| 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. |
| EntryCount | The number of records in the Entry arrays. |
| EntryAuthorEmail | This property contains the email address of the author. |
| EntryAuthorName | This property contains the name of the author. |
| EntryAuthorUri | This property contains the URI of the author. |
| EntryCategoryLabel | This property contains a textual description of the label for the category. |
| EntryCategoryScheme | This property identifies a categorization scheme. |
| EntryCategoryTerm | This property contains the category to which the entry or feed belongs. |
| EntryContent | This property contains the text contents of an Atom entry. |
| EntryContentTextType | This property contains the text type of the content of the entry. |
| EntryContributorEmail | This property contains the email address of the contributor. |
| EntryContributorName | This property contains the name of the contributor. |
| EntryContributorUri | This property contains the URI of the contributor. |
| EntryCopyright | This property is used a textual description of the copyright statement for the current ATOM feed. |
| EntryCreated | This property contains a Date value that indicates the time that the current entry was created. |
| EntryXML | This property contains the full XML contents of the entry. |
| EntryId | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| EntryIssued | This property contains a Date value that indicates the time that the current entry was issued. |
| EntryLinkHref | This property contains the location of the link. |
| EntryLinkHrefLang | This property contains the language of the content at the link. |
| EntryLinkLength | This property contains the length (in bytes) of the content at the link. |
| EntryLinkRel | This property indicates the relation of the linked content to the feed. |
| EntryLinkTitle | This property contains the title of the link. |
| EntryLinkType | This property contains the MIME type of the content at the link. |
| EntryModified | This property contains a Date value that indicates the time in which the current entry was last modified. |
| EntryPublished | This property contains the date that the entry was first created. |
| EntryRights | This property contains information about the rights of the given entry. |
| EntryRightsTextType | Text type of the rights of the feed. |
| EntrySource | This property is used when an entry has been copied from one feed to another feed. |
| EntrySummary | This property contains a short textual description of the Atom entry. |
| EntrySummaryTextType | This property contains the text type of the summary of the entry. |
| EntryTitle | This property contains the title of the current Atom Feed. |
| EntryTitleTextType | This property contains the text type of the title of the feed. |
| EntryUpdated | This property contains the date and time that the feed was updated. |
| 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. |
| 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). |
| Slug | A header added to the HTTP request. |
| 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. |
| UpdateEntryAuthorEmail | This property contains the email address of the author. |
| UpdateEntryAuthorName | This property contains the name of the author. |
| UpdateEntryAuthorUri | This property contains the URI of the author. |
| UpdateEntryCategoryLabel | This property contains a textual description of the label for the category. |
| UpdateEntryCategoryScheme | This property identifies a categorization scheme. |
| UpdateEntryCategoryTerm | This property contains the category to which the entry or feed belongs. |
| UpdateEntryContent | This property contains the text contents of an Atom entry. |
| UpdateEntryContentTextType | This property contains the text type of the content of the entry. |
| UpdateEntryContributorEmail | This property contains the email address of the contributor. |
| UpdateEntryContributorName | This property contains the name of the contributor. |
| UpdateEntryContributorUri | This property contains the URI of the contributor. |
| UpdateEntryCopyright | This property is used a textual description of the copyright statement for the current ATOM feed. |
| UpdateEntryCreated | This property contains a Date value that indicates the time that the current entry was created. |
| UpdateEntryXML | This property contains the full XML contents of the entry. |
| UpdateEntryId | The Id conveys a permanent, universally unique identifier for an entry or feed. |
| UpdateEntryIssued | This property contains a Date value that indicates the time that the current entry was issued. |
| UpdateEntryLinkHref | This property contains the location of the link. |
| UpdateEntryLinkHrefLang | This property contains the language of the content at the link. |
| UpdateEntryLinkLength | This property contains the length (in bytes) of the content at the link. |
| UpdateEntryLinkRel | This property indicates the relation of the linked content to the feed. |
| UpdateEntryLinkTitle | This property contains the title of the link. |
| UpdateEntryLinkType | This property contains the MIME type of the content at the link. |
| UpdateEntryModified | This property contains a Date value that indicates the time in which the current entry was last modified. |
| UpdateEntryPublished | This property contains the date that the entry was first created. |
| UpdateEntryRights | This property contains information about the rights of the given entry. |
| UpdateEntryRightsTextType | Text type of the rights of the feed. |
| UpdateEntrySource | This property is used when an entry has been copied from one feed to another feed. |
| UpdateEntrySummary | This property contains a short textual description of the Atom entry. |
| UpdateEntrySummaryTextType | This property contains the text type of the summary of the entry. |
| UpdateEntryTitle | This property contains the title of the current Atom Feed. |
| UpdateEntryTitleTextType | This property contains the text type of the title of the feed. |
| UpdateEntryUpdated | This property contains the date and time that the feed was updated. |
| UpdateFile | A resource to be updated, deleted or created. |
| User | A user name if authentication is to be used. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| AddCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
| AddNamespace | Adds a namespace to the Namespaces properties. |
| Config | Sets or retrieves a configuration setting . |
| DeleteResource | Deletes the resource at the specified URL. |
| DoEvents | Processes events from the internal message queue. |
| GetFeed | Fetches an Atom feed. |
| GetProperty | Fetches the value of a specific Atom feed element or attribute. |
| GetResource | Fetches a resource. |
| Interrupt | Interrupt the current method. |
| PostResource | Posts a resource to the specified URL. |
| Put | Sends data to the HTTP server using the HTTP PUT method. |
| PutResource | Puts a resource to the specified URL. |
| ReadFile | Load an Atom file into the component. |
| Reset | Reset all properties of the component. |
| SetProperty | Sets the value of a specific Atom feed property. |
| WriteFile | Write an Atom feed from the component. |
Event List
The following is the full list of the events fired by the control 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. |
| 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 control with short descriptions. Click on the links for further details.
| 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. |