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

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.

AcceptA list of acceptable MIME types for the request.
AtomDataThe complete content of the Atom resource.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ChannelAuthorEmailThis property contains the email address of the author.
ChannelAuthorNameThis property contains the name of the author.
ChannelAuthorUriThis property contains the URI of the author.
ChannelCategoryLabelThis property contains a textual description of the label for the category.
ChannelCategorySchemeThis property identifies a categorization scheme.
ChannelCategoryTermThis property contains the category to which the entry or feed belongs.
ChannelContributorEmailThis property contains the email address of the contributor.
ChannelContributorNameThis property contains the name of the contributor.
ChannelContributorUriThis property contains the URI of the contributor.
ChannelGeneratorThis property identifies the generator of the feed.
ChannelIconThis property contains a reference to the image that represents this feed.
ChannelIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
ChannelLinkHrefThis property contains the location of the link.
ChannelLinkHrefLangThis property contains the language of the content at the link.
ChannelLinkLengthThis property contains the length (in bytes) of the content at the link.
ChannelLinkRelThis property indicates the relation of the linked content to the feed.
ChannelLinkTitleThis property contains the title of the link.
ChannelLinkTypeThis property contains the MIME type of the content at the link.
ChannelLogoThis property contains logo for an image that represents the feed.
ChannelRightsThis property contains information about the rights of the given feed.
ChannelRightsTextTypeText type of the rights of the feed.
ChannelSubtitleThis contains a short description of the Atom Feed.
ChannelSubtitleTextTypeThis property contains the text type of the sub-title of the feed.
ChannelTitleThis property contains the title of the current Atom Feed.
ChannelTitleTextTypeThis property contains the text type of the title of the feed.
ChannelUpdatedThis property contains the date and time that the feed was updated.
ConnectedShows whether the component is connected.
ContentTypeContent type for posts and puts.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThe domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThe name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
EntryCountThe number of records in the Entry arrays.
EntryAuthorEmailThis property contains the email address of the author.
EntryAuthorNameThis property contains the name of the author.
EntryAuthorUriThis property contains the URI of the author.
EntryCategoryLabelThis property contains a textual description of the label for the category.
EntryCategorySchemeThis property identifies a categorization scheme.
EntryCategoryTermThis property contains the category to which the entry or feed belongs.
EntryContentThis property contains the text contents of an Atom entry.
EntryContentTextTypeThis property contains the text type of the content of the entry.
EntryContributorEmailThis property contains the email address of the contributor.
EntryContributorNameThis property contains the name of the contributor.
EntryContributorUriThis property contains the URI of the contributor.
EntryCopyrightThis property is used a textual description of the copyright statement for the current ATOM feed.
EntryCreatedThis property contains a Date value that indicates the time that the current entry was created.
EntryXMLThis property contains the full XML contents of the entry.
EntryIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
EntryIssuedThis property contains a Date value that indicates the time that the current entry was issued.
EntryLinkHrefThis property contains the location of the link.
EntryLinkHrefLangThis property contains the language of the content at the link.
EntryLinkLengthThis property contains the length (in bytes) of the content at the link.
EntryLinkRelThis property indicates the relation of the linked content to the feed.
EntryLinkTitleThis property contains the title of the link.
EntryLinkTypeThis property contains the MIME type of the content at the link.
EntryModifiedThis property contains a Date value that indicates the time in which the current entry was last modified.
EntryPublishedThis property contains the date that the entry was first created.
EntryRightsThis property contains information about the rights of the given entry.
EntryRightsTextTypeText type of the rights of the feed.
EntrySourceThis property is used when an entry has been copied from one feed to another feed.
EntrySummaryThis property contains a short textual description of the Atom entry.
EntrySummaryTextTypeThis property contains the text type of the summary of the entry.
EntryTitleThis property contains the title of the current Atom Feed.
EntryTitleTextTypeThis property contains the text type of the title of the feed.
EntryUpdatedThis property contains the date and time that the feed was updated.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
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.
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.
NamespaceCountThe number of records in the Namespace arrays.
NamespacePrefixThe Prefix for the Namespace .
NamespaceURINamespace URI associated with the corresponding Prefix .
OtherHeadersOther headers as determined by the user (optional).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA password if authentication is to be used.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RefererReferer URL/document (optional).
SlugA header added to the HTTP request.
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.
UpdateEntryAuthorEmailThis property contains the email address of the author.
UpdateEntryAuthorNameThis property contains the name of the author.
UpdateEntryAuthorUriThis property contains the URI of the author.
UpdateEntryCategoryLabelThis property contains a textual description of the label for the category.
UpdateEntryCategorySchemeThis property identifies a categorization scheme.
UpdateEntryCategoryTermThis property contains the category to which the entry or feed belongs.
UpdateEntryContentThis property contains the text contents of an Atom entry.
UpdateEntryContentTextTypeThis property contains the text type of the content of the entry.
UpdateEntryContributorEmailThis property contains the email address of the contributor.
UpdateEntryContributorNameThis property contains the name of the contributor.
UpdateEntryContributorUriThis property contains the URI of the contributor.
UpdateEntryCopyrightThis property is used a textual description of the copyright statement for the current ATOM feed.
UpdateEntryCreatedThis property contains a Date value that indicates the time that the current entry was created.
UpdateEntryXMLThis property contains the full XML contents of the entry.
UpdateEntryIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
UpdateEntryIssuedThis property contains a Date value that indicates the time that the current entry was issued.
UpdateEntryLinkHrefThis property contains the location of the link.
UpdateEntryLinkHrefLangThis property contains the language of the content at the link.
UpdateEntryLinkLengthThis property contains the length (in bytes) of the content at the link.
UpdateEntryLinkRelThis property indicates the relation of the linked content to the feed.
UpdateEntryLinkTitleThis property contains the title of the link.
UpdateEntryLinkTypeThis property contains the MIME type of the content at the link.
UpdateEntryModifiedThis property contains a Date value that indicates the time in which the current entry was last modified.
UpdateEntryPublishedThis property contains the date that the entry was first created.
UpdateEntryRightsThis property contains information about the rights of the given entry.
UpdateEntryRightsTextTypeText type of the rights of the feed.
UpdateEntrySourceThis property is used when an entry has been copied from one feed to another feed.
UpdateEntrySummaryThis property contains a short textual description of the Atom entry.
UpdateEntrySummaryTextTypeThis property contains the text type of the summary of the entry.
UpdateEntryTitleThis property contains the title of the current Atom Feed.
UpdateEntryTitleTextTypeThis property contains the text type of the title of the feed.
UpdateEntryUpdatedThis property contains the date and time that the feed was updated.
UpdateFileA resource to be updated, deleted or created.
UserA 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.

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AddNamespaceAdds a namespace to the Namespaces properties.
ConfigSets or retrieves a configuration setting .
DeleteResourceDeletes the resource at the specified URL.
DoEventsProcesses events from the internal message queue.
GetFeedFetches an Atom feed.
GetPropertyFetches the value of a specific Atom feed element or attribute.
GetResourceFetches a resource.
InterruptInterrupt the current method.
PostResourcePosts a resource to the specified URL.
PutSends data to the HTTP server using the HTTP PUT method.
PutResourcePuts a resource to the specified URL.
ReadFileLoad an Atom file into the component.
ResetReset all properties of the component.
SetPropertySets the value of a specific Atom feed property.
WriteFileWrite 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.

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.
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 control with short descriptions. Click on the links for further details.

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