Atom Component

Properties   Methods   Events   Config Settings   Errors  

The Atom Component is used to retrieve, parse, and update Atom content.

Syntax

TipwAtom

Remarks

The Atom component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The Atom Component 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 component 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 Component 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 component with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Accept Property (Atom Component)

This property includes a list of acceptable MIME types for the request.

Syntax

__property String Accept = { read=FAccept, write=FSetAccept };

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Data Type

String

AtomData Property (Atom Component)

This is the complete content of the Atom resource.

Syntax

__property String AtomData = { read=FAtomData, write=FSetAtomData };
__property DynamicArray<Byte> AtomDataB = { read=FAtomDataB, write=FSetAtomDataB };

Default Value

""

Remarks

This property will contain the bytes received when retrieving Atom feeds or a media type through the GetResource method. When writing an Atom feed using the WriteFile method, the AtomData will be generated from the existing properties.

This property is not available at design time.

Data Type

Byte Array

Authorization Property (Atom Component)

This property includes the Authorization string to be sent to the server.

Syntax

__property String Authorization = { read=FAuthorization, write=FSetAuthorization };

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (Atom Component)

The authentication scheme to use when server authentication is required.

Syntax

__property TipwAtomAuthSchemes AuthScheme = { read=FAuthScheme, write=FSetAuthScheme };

enum TipwAtomAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5,
  authOAuth=6
};

Default Value

authBasic

Remarks

This property will tell the component which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of User, Password, and Authorization.

Data Type

Integer

ChannelAuthorEmail Property (Atom Component)

This property contains the email address of the author.

Syntax

__property String ChannelAuthorEmail = { read=FChannelAuthorEmail, write=FSetChannelAuthorEmail };

Default Value

""

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorName Property (Atom Component)

This property contains the name of the author.

Syntax

__property String ChannelAuthorName = { read=FChannelAuthorName, write=FSetChannelAuthorName };

Default Value

""

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the author.

Syntax

__property String ChannelAuthorUri = { read=FChannelAuthorUri, write=FSetChannelAuthorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

This property is not available at design time.

Data Type

String

ChannelCategoryLabel Property (Atom Component)

This property contains a textual description of the label for the category.

Syntax

__property String ChannelCategoryLabel = { read=FChannelCategoryLabel, write=FSetChannelCategoryLabel };

Default Value

""

Remarks

This property contains a textual description of the label for the category.

This property is not available at design time.

Data Type

String

ChannelCategoryScheme Property (Atom Component)

This property identifies a categorization scheme.

Syntax

__property String ChannelCategoryScheme = { read=FChannelCategoryScheme, write=FSetChannelCategoryScheme };

Default Value

""

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

ChannelCategoryTerm Property (Atom Component)

This property contains the category to which the entry or feed belongs.

Syntax

__property String ChannelCategoryTerm = { read=FChannelCategoryTerm, write=FSetChannelCategoryTerm };

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

This property is not available at design time.

Data Type

String

ChannelContributorEmail Property (Atom Component)

This property contains the email address of the contributor.

Syntax

__property String ChannelContributorEmail = { read=FChannelContributorEmail, write=FSetChannelContributorEmail };

Default Value

""

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorName Property (Atom Component)

This property contains the name of the contributor.

Syntax

__property String ChannelContributorName = { read=FChannelContributorName, write=FSetChannelContributorName };

Default Value

""

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

__property String ChannelContributorUri = { read=FChannelContributorUri, write=FSetChannelContributorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

This property is not available at design time.

Data Type

String

ChannelGenerator Property (Atom Component)

This property identifies the generator of the feed.

Syntax

__property String ChannelGenerator = { read=FChannelGenerator, write=FSetChannelGenerator };

Default Value

""

Remarks

This property identifies the generator of the feed.

This property is not available at design time.

Data Type

String

ChannelIcon Property (Atom Component)

This property contains a reference to the image that represents this feed.

Syntax

__property String ChannelIcon = { read=FChannelIcon, write=FSetChannelIcon };

Default Value

""

Remarks

This property contains a reference to the image that represents this feed.

This property is not available at design time.

Data Type

String

ChannelId Property (Atom Component)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

__property String ChannelId = { read=FChannelId, write=FSetChannelId };

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

Data Type

String

ChannelLinkHref Property (Atom Component)

This property contains the location of the link.

Syntax

__property String ChannelLinkHref = { read=FChannelLinkHref, write=FSetChannelLinkHref };

Default Value

""

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

ChannelLinkHrefLang Property (Atom Component)

This property contains the language of the content at the link.

Syntax

__property String ChannelLinkHrefLang = { read=FChannelLinkHrefLang, write=FSetChannelLinkHrefLang };

Default Value

""

Remarks

This property contains the language of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkLength Property (Atom Component)

This property contains the length (in bytes) of the content at the link.

Syntax

__property String ChannelLinkLength = { read=FChannelLinkLength, write=FSetChannelLinkLength };

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkRel Property (Atom Component)

This property indicates the relation of the linked content to the feed.

Syntax

__property String ChannelLinkRel = { read=FChannelLinkRel, write=FSetChannelLinkRel };

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

This property is not available at design time.

Data Type

String

ChannelLinkTitle Property (Atom Component)

This property contains the title of the link.

Syntax

__property String ChannelLinkTitle = { read=FChannelLinkTitle, write=FSetChannelLinkTitle };

Default Value

""

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

ChannelLinkType Property (Atom Component)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

__property String ChannelLinkType = { read=FChannelLinkType, write=FSetChannelLinkType };

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLogo Property (Atom Component)

This property contains the logo for an image that represents the feed.

Syntax

__property String ChannelLogo = { read=FChannelLogo, write=FSetChannelLogo };

Default Value

""

Remarks

This property contains the logo for an image that represents the feed.

This property is not available at design time.

Data Type

String

ChannelRights Property (Atom Component)

This property contains information about the rights of the given feed.

Syntax

__property String ChannelRights = { read=FChannelRights, write=FSetChannelRights };

Default Value

""

Remarks

This property contains information about the rights of the given feed.

This property is not available at design time.

Data Type

String

ChannelRightsTextType Property (Atom Component)

This property contains the text type of the rights of the feed.

Syntax

__property TipwAtomChannelRightsTextTypes ChannelRightsTextType = { read=FChannelRightsTextType, write=FSetChannelRightsTextType };

enum TipwAtomChannelRightsTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelSubtitle Property (Atom Component)

This property contains a short description of the Atom feed.

Syntax

__property String ChannelSubtitle = { read=FChannelSubtitle, write=FSetChannelSubtitle };

Default Value

""

Remarks

This property contains a short description of the Atom feed.

Data Type

String

ChannelSubtitleTextType Property (Atom Component)

This property contains the text type of the subtitle of the feed.

Syntax

__property TipwAtomChannelSubtitleTextTypes ChannelSubtitleTextType = { read=FChannelSubtitleTextType, write=FSetChannelSubtitleTextType };

enum TipwAtomChannelSubtitleTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelTitle Property (Atom Component)

This property contains the title of the current Atom feed.

Syntax

__property String ChannelTitle = { read=FChannelTitle, write=FSetChannelTitle };

Default Value

""

Remarks

This property contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

Data Type

String

ChannelTitleTextType Property (Atom Component)

This property contains the text type of the title of the feed.

Syntax

__property TipwAtomChannelTitleTextTypes ChannelTitleTextType = { read=FChannelTitleTextType, write=FSetChannelTitleTextType };

enum TipwAtomChannelTitleTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelUpdated Property (Atom Component)

This property contains the date and time that the feed was updated.

Syntax

__property String ChannelUpdated = { read=FChannelUpdated, write=FSetChannelUpdated };

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

Data Type

String

Connected Property (Atom Component)

This shows whether the component is connected.

Syntax

__property bool Connected = { read=FConnected, write=FSetConnected };

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

ContentType Property (Atom Component)

This is the content type for posts and puts.

Syntax

__property String ContentType = { read=FContentType, write=FSetContentType };

Default Value

"application/atom+xml"

Remarks

If this property contains a nonempty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a PostResource or PutResource to the server.

This property is not available at design time.

Data Type

String

CookieCount Property (Atom Component)

The number of records in the Cookie arrays.

Syntax

__property int CookieCount = { read=FCookieCount, write=FSetCookieCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (Atom Component)

This is the domain of a received cookie.

Syntax

__property String CookieDomain[int CookieIndex] = { read=FCookieDomain };

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieExpiration Property (Atom Component)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

__property String CookieExpiration[int CookieIndex] = { read=FCookieExpiration };

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieName Property (Atom Component)

This property, contains the name of the cookie.

Syntax

__property String CookieName[int CookieIndex] = { read=FCookieName, write=FSetCookieName };

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (Atom Component)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

__property String CookiePath[int CookieIndex] = { read=FCookiePath };

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieSecure Property (Atom Component)

This property contains the security flag of the received cookie.

Syntax

__property bool CookieSecure[int CookieIndex] = { read=FCookieSecure };

Default Value

false

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CookieValue Property (Atom Component)

This property contains the value of the cookie.

Syntax

__property String CookieValue[int CookieIndex] = { read=FCookieValue, write=FSetCookieValue };

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

EntryCount Property (Atom Component)

The number of records in the Entry arrays.

Syntax

__property int EntryCount = { read=FEntryCount, write=FSetEntryCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• EntryAuthorEmail
• EntryAuthorName
• EntryAuthorUri
• EntryCategoryLabel
• EntryCategoryScheme
• EntryCategoryTerm
• EntryContent
• EntryContentTextType
• EntryContributorEmail
• EntryContributorName
• EntryContributorUri
• EntryCopyright
• EntryCreated
• EntryId
• EntryIssued
• EntryLinkHref
• EntryLinkHrefLang
• EntryLinkLength
• EntryLinkRel
• EntryLinkTitle
• EntryLinkType
• EntryModified
• EntryPublished
• EntryRights
• EntryRightsTextType
• EntrySource
• EntrySummary
• EntrySummaryTextType
• EntryTitle
• EntryTitleTextType
• EntryUpdated
• EntryXML

The array indices start at 0 and end at EntryCount - 1.

This property is not available at design time.

Data Type

Integer

EntryAuthorEmail Property (Atom Component)

This property contains the email address of the author.

Syntax

__property String EntryAuthorEmail[int EntryIndex] = { read=FEntryAuthorEmail, write=FSetEntryAuthorEmail };

Default Value

""

Remarks

This property contains the email address of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryAuthorName Property (Atom Component)

This property contains the name of the author.

Syntax

__property String EntryAuthorName[int EntryIndex] = { read=FEntryAuthorName, write=FSetEntryAuthorName };

Default Value

""

Remarks

This property contains the name of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryAuthorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the author.

Syntax

__property String EntryAuthorUri[int EntryIndex] = { read=FEntryAuthorUri, write=FSetEntryAuthorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryLabel Property (Atom Component)

This property contains a textual description of the label for the category.

Syntax

__property String EntryCategoryLabel[int EntryIndex] = { read=FEntryCategoryLabel, write=FSetEntryCategoryLabel };

Default Value

""

Remarks

This property contains a textual description of the label for the category.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryScheme Property (Atom Component)

This property identifies a categorization scheme.

Syntax

__property String EntryCategoryScheme[int EntryIndex] = { read=FEntryCategoryScheme, write=FSetEntryCategoryScheme };

Default Value

""

Remarks

This property identifies a categorization scheme.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryTerm Property (Atom Component)

This property contains the category to which the entry or feed belongs.

Syntax

__property String EntryCategoryTerm[int EntryIndex] = { read=FEntryCategoryTerm, write=FSetEntryCategoryTerm };

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContent Property (Atom Component)

This property contains the text contents of an Atom entry.

Syntax

__property String EntryContent[int EntryIndex] = { read=FEntryContent, write=FSetEntryContent };

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContentTextType Property (Atom Component)

This property contains the text type of the content of the entry.

Syntax

__property TipwAtomEntryContentTextTypes EntryContentTextType[int EntryIndex] = { read=FEntryContentTextType, write=FSetEntryContentTextType };

enum TipwAtomEntryContentTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the content of the entry. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryContributorEmail Property (Atom Component)

This property contains the email address of the contributor.

Syntax

__property String EntryContributorEmail[int EntryIndex] = { read=FEntryContributorEmail, write=FSetEntryContributorEmail };

Default Value

""

Remarks

This property contains the email address of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContributorName Property (Atom Component)

This property contains the name of the contributor.

Syntax

__property String EntryContributorName[int EntryIndex] = { read=FEntryContributorName, write=FSetEntryContributorName };

Default Value

""

Remarks

This property contains the name of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContributorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

__property String EntryContributorUri[int EntryIndex] = { read=FEntryContributorUri, write=FSetEntryContributorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCopyright Property (Atom Component)

This property includes a textual description of the copyright statement for the current ATOM feed.

Syntax

__property String EntryCopyright[int EntryIndex] = { read=FEntryCopyright, write=FSetEntryCopyright };

Default Value

""

Remarks

This property includes a textual description of the copyright statement for the current ATOM feed.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCreated Property (Atom Component)

This property contains a date value that indicates the time that the current entry was created.

Syntax

__property String EntryCreated[int EntryIndex] = { read=FEntryCreated, write=FSetEntryCreated };

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was created.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryXML Property (Atom Component)

This property contains the full XML contents of the entry.

Syntax

__property String EntryXML[int EntryIndex] = { read=FEntryXML, write=FSetEntryXML };

Default Value

""

Remarks

This property contains the full XML contents of the entry. Unless the properties of the AtomEntry are modified, this value will contain the original XML from the Atom feed.

Note: When setting this property, the entire contents of the entry must be supplied, including the entry tags. All previous entry values will be lost.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryId Property (Atom Component)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

__property String EntryId[int EntryIndex] = { read=FEntryId, write=FSetEntryId };

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an internationalized resource identifier (IRI) as defined by RFC 3987.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryIssued Property (Atom Component)

This property contains a date value that indicates the time that the current entry was issued.

Syntax

__property String EntryIssued[int EntryIndex] = { read=FEntryIssued, write=FSetEntryIssued };

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was issued.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkHref Property (Atom Component)

This property contains the location of the link.

Syntax

__property String EntryLinkHref[int EntryIndex] = { read=FEntryLinkHref, write=FSetEntryLinkHref };

Default Value

""

Remarks

This property contains the location of the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkHrefLang Property (Atom Component)

This property contains the language of the content at the link.

Syntax

__property String EntryLinkHrefLang[int EntryIndex] = { read=FEntryLinkHrefLang, write=FSetEntryLinkHrefLang };

Default Value

""

Remarks

This property contains the language of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkLength Property (Atom Component)

This property contains the length (in bytes) of the content at the link.

Syntax

__property String EntryLinkLength[int EntryIndex] = { read=FEntryLinkLength, write=FSetEntryLinkLength };

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkRel Property (Atom Component)

This property indicates the relation of the linked content to the feed.

Syntax

__property String EntryLinkRel[int EntryIndex] = { read=FEntryLinkRel, write=FSetEntryLinkRel };

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkTitle Property (Atom Component)

This property contains the title of the link.

Syntax

__property String EntryLinkTitle[int EntryIndex] = { read=FEntryLinkTitle, write=FSetEntryLinkTitle };

Default Value

""

Remarks

This property contains the title of the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkType Property (Atom Component)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

__property String EntryLinkType[int EntryIndex] = { read=FEntryLinkType, write=FSetEntryLinkType };

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryModified Property (Atom Component)

This property contains a date value that indicates the time in which the current entry was last modified.

Syntax

__property String EntryModified[int EntryIndex] = { read=FEntryModified, write=FSetEntryModified };

Default Value

""

Remarks

This property contains a date value that indicates the time in which the current entry was last modified.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryPublished Property (Atom Component)

This property contains the date that the entry was first created.

Syntax

__property String EntryPublished[int EntryIndex] = { read=FEntryPublished, write=FSetEntryPublished };

Default Value

""

Remarks

This property contains the date that the entry was first created.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryRights Property (Atom Component)

This property contains information about the rights of the given entry.

Syntax

__property String EntryRights[int EntryIndex] = { read=FEntryRights, write=FSetEntryRights };

Default Value

""

Remarks

This property contains information about the rights of the given entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryRightsTextType Property (Atom Component)

This property contains the text type of the rights of the feed.

Syntax

__property TipwAtomEntryRightsTextTypes EntryRightsTextType[int EntryIndex] = { read=FEntryRightsTextType, write=FSetEntryRightsTextType };

enum TipwAtomEntryRightsTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntrySource Property (Atom Component)

This property is used when an entry has been copied from one feed to another feed.

Syntax

__property String EntrySource[int EntryIndex] = { read=FEntrySource, write=FSetEntrySource };

Default Value

""

Remarks

This property is used when an entry has been copied from one feed to another feed. It preserves all child elements of the feed other than the entries.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntrySummary Property (Atom Component)

This property contains a short textual description of the Atom entry.

Syntax

__property String EntrySummary[int EntryIndex] = { read=FEntrySummary, write=FSetEntrySummary };

Default Value

""

Remarks

This property contains a short textual description of the Atom entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntrySummaryTextType Property (Atom Component)

This property contains the text type of the summary of the entry.

Syntax

__property TipwAtomEntrySummaryTextTypes EntrySummaryTextType[int EntryIndex] = { read=FEntrySummaryTextType, write=FSetEntrySummaryTextType };

enum TipwAtomEntrySummaryTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the summary of the entry. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryTitle Property (Atom Component)

This property contains the title of the current Atom Feed.

Syntax

__property String EntryTitle[int EntryIndex] = { read=FEntryTitle, write=FSetEntryTitle };

Default Value

""

Remarks

This property contains the title of the current Atom Feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryTitleTextType Property (Atom Component)

This property contains the text type of the title of the feed.

Syntax

__property TipwAtomEntryTitleTextTypes EntryTitleTextType[int EntryIndex] = { read=FEntryTitleTextType, write=FSetEntryTitleTextType };

enum TipwAtomEntryTitleTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryUpdated Property (Atom Component)

This property contains the date and time that the feed was updated.

Syntax

__property String EntryUpdated[int EntryIndex] = { read=FEntryUpdated, write=FSetEntryUpdated };

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (Atom Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (Atom Component)

This property determines the type of firewall to connect through.

Syntax

__property TipwAtomFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TipwAtomFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (Atom Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (Atom Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (Atom Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (Atom Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

FollowRedirects Property (Atom Component)

This property determines what happens when the server issues a redirect.

Syntax

__property TipwAtomFollowRedirects FollowRedirects = { read=FFollowRedirects, write=FSetFollowRedirects };

enum TipwAtomFollowRedirects {
  frNever=0,
  frAlways=1,
  frSameScheme=2
};

Default Value

frNever

Remarks

This property determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the component raises an exception.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the component raises an exception instead.

Data Type

Integer

Idle Property (Atom Component)

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (Atom Component)

This property includes a date determining the maximum age of the desired document.

Syntax

__property String IfModifiedSince = { read=FIfModifiedSince, write=FSetIfModifiedSince };

Default Value

""

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component raises an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

This property is not available at design time.

Data Type

String

LocalFile Property (Atom Component)

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

Data Type

String

LocalHost Property (Atom Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NamespaceCount Property (Atom Component)

The number of records in the Namespace arrays.

Syntax

__property int NamespaceCount = { read=FNamespaceCount, write=FSetNamespaceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (Atom Component)

The Prefix for the Namespace .

Syntax

__property String NamespacePrefix[int NamespaceIndex] = { read=FNamespacePrefix, write=FSetNamespacePrefix };

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (Atom Component)

Namespace URI associated with the corresponding Prefix .

Syntax

__property String NamespaceURI[int NamespaceIndex] = { read=FNamespaceURI, write=FSetNamespaceURI };

Default Value

""

Remarks

Namespace URI associated with the corresponding NamespacePrefix. This is usually a URL pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

OtherHeaders Property (Atom Component)

This property includes other headers as determined by the user (optional).

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (Atom Component)

The number of records in the ParsedHeader arrays.

Syntax

__property int ParsedHeaderCount = { read=FParsedHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (Atom Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (Atom Component)

This property contains the header contents.

Syntax

__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

Password Property (Atom Component)

This property includes a password if authentication is to be used.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Data Type

String

ProxyAuthScheme Property (Atom Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TipwAtomProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TipwAtomProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Atom Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (Atom Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Atom Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Atom Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Atom Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TipwAtomProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TipwAtomProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (Atom Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Referer Property (Atom Component)

This property includes the referer URL/document (optional).

Syntax

__property String Referer = { read=FReferer, write=FSetReferer };

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

Data Type

String

Slug Property (Atom Component)

A header added to the HTTP request.

Syntax

__property String Slug = { read=FSlug, write=FSetSlug };

Default Value

""

Remarks

This property requests that the server use the header's value as part of any URLs that it normally would generate when creating the Entry or Media resources. Some servers ignore this header.

Data Type

String

SSLAcceptServerCertEncoded Property (Atom Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (Atom Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (Atom Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (Atom Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Atom Component)

This is the type of certificate store for this certificate.

Syntax

__property TipwAtomSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TipwAtomSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (Atom Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (Atom Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TipwAtomSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TipwAtomSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (Atom Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

Timeout Property (Atom Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (Atom Component)

This property includes the contents of the last response from the server.

Syntax

__property String TransferredData = { read=FTransferredData };
__property DynamicArray<Byte> TransferredDataB = { read=FTransferredDataB };

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only and not available at design time.

Data Type

Byte Array

TransferredDataLimit Property (Atom Component)

This property includes the maximum number of bytes of data to be transferred.

Syntax

__property __int64 TransferredDataLimit = { read=FTransferredDataLimit, write=FSetTransferredDataLimit };

Default Value

0

Remarks

This property defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the component will accumulate and parse. If this value is set to a number n that is greater than zero, the component will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (Atom Component)

This property includes the full set of headers as received from the server.

Syntax

__property String TransferredHeaders = { read=FTransferredHeaders };

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the component.

This property is read-only and not available at design time.

Data Type

String

UpdateEntryAuthorEmail Property (Atom Component)

This property contains the email address of the author.

Syntax

__property String UpdateEntryAuthorEmail = { read=FUpdateEntryAuthorEmail, write=FSetUpdateEntryAuthorEmail };

Default Value

""

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

UpdateEntryAuthorName Property (Atom Component)

This property contains the name of the author.

Syntax

__property String UpdateEntryAuthorName = { read=FUpdateEntryAuthorName, write=FSetUpdateEntryAuthorName };

Default Value

""

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

UpdateEntryAuthorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the author.

Syntax

__property String UpdateEntryAuthorUri = { read=FUpdateEntryAuthorUri, write=FSetUpdateEntryAuthorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

This property is not available at design time.

Data Type

String

UpdateEntryCategoryLabel Property (Atom Component)

This property contains a textual description of the label for the category.

Syntax

__property String UpdateEntryCategoryLabel = { read=FUpdateEntryCategoryLabel, write=FSetUpdateEntryCategoryLabel };

Default Value

""

Remarks

This property contains a textual description of the label for the category.

This property is not available at design time.

Data Type

String

UpdateEntryCategoryScheme Property (Atom Component)

This property identifies a categorization scheme.

Syntax

__property String UpdateEntryCategoryScheme = { read=FUpdateEntryCategoryScheme, write=FSetUpdateEntryCategoryScheme };

Default Value

""

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

UpdateEntryCategoryTerm Property (Atom Component)

This property contains the category to which the entry or feed belongs.

Syntax

__property String UpdateEntryCategoryTerm = { read=FUpdateEntryCategoryTerm, write=FSetUpdateEntryCategoryTerm };

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

This property is not available at design time.

Data Type

String

UpdateEntryContent Property (Atom Component)

This property contains the text contents of an Atom entry.

Syntax

__property String UpdateEntryContent = { read=FUpdateEntryContent, write=FSetUpdateEntryContent };

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

Data Type

String

UpdateEntryContentTextType Property (Atom Component)

This property contains the text type of the content of the entry.

Syntax

__property TipwAtomUpdateEntryContentTextTypes UpdateEntryContentTextType = { read=FUpdateEntryContentTextType, write=FSetUpdateEntryContentTextType };

enum TipwAtomUpdateEntryContentTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the content of the entry. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

UpdateEntryContributorEmail Property (Atom Component)

This property contains the email address of the contributor.

Syntax

__property String UpdateEntryContributorEmail = { read=FUpdateEntryContributorEmail, write=FSetUpdateEntryContributorEmail };

Default Value

""

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

UpdateEntryContributorName Property (Atom Component)

This property contains the name of the contributor.

Syntax

__property String UpdateEntryContributorName = { read=FUpdateEntryContributorName, write=FSetUpdateEntryContributorName };

Default Value

""

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

UpdateEntryContributorUri Property (Atom Component)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

__property String UpdateEntryContributorUri = { read=FUpdateEntryContributorUri, write=FSetUpdateEntryContributorUri };

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

This property is not available at design time.

Data Type

String

UpdateEntryCopyright Property (Atom Component)

This property includes a textual description of the copyright statement for the current ATOM feed.

Syntax

__property String UpdateEntryCopyright = { read=FUpdateEntryCopyright, write=FSetUpdateEntryCopyright };

Default Value

""

Remarks

This property includes a textual description of the copyright statement for the current ATOM feed.

This property is not available at design time.

Data Type

String

UpdateEntryCreated Property (Atom Component)

This property contains a date value that indicates the time that the current entry was created.

Syntax

__property String UpdateEntryCreated = { read=FUpdateEntryCreated, write=FSetUpdateEntryCreated };

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was created.

This property is not available at design time.

Data Type

String

UpdateEntryXML Property (Atom Component)

This property contains the full XML contents of the entry.

Syntax

__property String UpdateEntryXML = { read=FUpdateEntryXML, write=FSetUpdateEntryXML };

Default Value

""

Remarks

This property contains the full XML contents of the entry. Unless the properties of the AtomEntry are modified, this value will contain the original XML from the Atom feed.

Note: When setting this property, the entire contents of the entry must be supplied, including the entry tags. All previous entry values will be lost.

This property is not available at design time.

Data Type

String

UpdateEntryId Property (Atom Component)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

__property String UpdateEntryId = { read=FUpdateEntryId, write=FSetUpdateEntryId };

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an internationalized resource identifier (IRI) as defined by RFC 3987.

Data Type

String

UpdateEntryIssued Property (Atom Component)

This property contains a date value that indicates the time that the current entry was issued.

Syntax

__property String UpdateEntryIssued = { read=FUpdateEntryIssued, write=FSetUpdateEntryIssued };

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was issued.

This property is not available at design time.

Data Type

String

UpdateEntryLinkHref Property (Atom Component)

This property contains the location of the link.

Syntax

__property String UpdateEntryLinkHref = { read=FUpdateEntryLinkHref, write=FSetUpdateEntryLinkHref };

Default Value

""

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkHrefLang Property (Atom Component)

This property contains the language of the content at the link.

Syntax

__property String UpdateEntryLinkHrefLang = { read=FUpdateEntryLinkHrefLang, write=FSetUpdateEntryLinkHrefLang };

Default Value

""

Remarks

This property contains the language of the content at the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkLength Property (Atom Component)

This property contains the length (in bytes) of the content at the link.

Syntax

__property String UpdateEntryLinkLength = { read=FUpdateEntryLinkLength, write=FSetUpdateEntryLinkLength };

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkRel Property (Atom Component)

This property indicates the relation of the linked content to the feed.

Syntax

__property String UpdateEntryLinkRel = { read=FUpdateEntryLinkRel, write=FSetUpdateEntryLinkRel };

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

This property is not available at design time.

Data Type

String

UpdateEntryLinkTitle Property (Atom Component)

This property contains the title of the link.

Syntax

__property String UpdateEntryLinkTitle = { read=FUpdateEntryLinkTitle, write=FSetUpdateEntryLinkTitle };

Default Value

""

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkType Property (Atom Component)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

__property String UpdateEntryLinkType = { read=FUpdateEntryLinkType, write=FSetUpdateEntryLinkType };

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

This property is not available at design time.

Data Type

String

UpdateEntryModified Property (Atom Component)

This property contains a date value that indicates the time in which the current entry was last modified.

Syntax

__property String UpdateEntryModified = { read=FUpdateEntryModified, write=FSetUpdateEntryModified };

Default Value

""

Remarks

This property contains a date value that indicates the time in which the current entry was last modified.

This property is not available at design time.

Data Type

String

UpdateEntryPublished Property (Atom Component)

This property contains the date that the entry was first created.

Syntax

__property String UpdateEntryPublished = { read=FUpdateEntryPublished, write=FSetUpdateEntryPublished };

Default Value

""

Remarks

This property contains the date that the entry was first created.

Data Type

String

UpdateEntryRights Property (Atom Component)

This property contains information about the rights of the given entry.

Syntax

__property String UpdateEntryRights = { read=FUpdateEntryRights, write=FSetUpdateEntryRights };

Default Value

""

Remarks

This property contains information about the rights of the given entry.

Data Type

String

UpdateEntryRightsTextType Property (Atom Component)

This property contains the text type of the rights of the feed.

Syntax

__property TipwAtomUpdateEntryRightsTextTypes UpdateEntryRightsTextType = { read=FUpdateEntryRightsTextType, write=FSetUpdateEntryRightsTextType };

enum TipwAtomUpdateEntryRightsTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

UpdateEntrySource Property (Atom Component)

This property is used when an entry has been copied from one feed to another feed.

Syntax

__property String UpdateEntrySource = { read=FUpdateEntrySource, write=FSetUpdateEntrySource };

Default Value

""

Remarks

This property is used when an entry has been copied from one feed to another feed. It preserves all child elements of the feed other than the entries.

Data Type

String

UpdateEntrySummary Property (Atom Component)

This property contains a short textual description of the Atom entry.

Syntax

__property String UpdateEntrySummary = { read=FUpdateEntrySummary, write=FSetUpdateEntrySummary };

Default Value

""

Remarks

This property contains a short textual description of the Atom entry.

Data Type

String

UpdateEntrySummaryTextType Property (Atom Component)

This property contains the text type of the summary of the entry.

Syntax

__property TipwAtomUpdateEntrySummaryTextTypes UpdateEntrySummaryTextType = { read=FUpdateEntrySummaryTextType, write=FSetUpdateEntrySummaryTextType };

enum TipwAtomUpdateEntrySummaryTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the summary of the entry. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

UpdateEntryTitle Property (Atom Component)

This property contains the title of the current Atom Feed.

Syntax

__property String UpdateEntryTitle = { read=FUpdateEntryTitle, write=FSetUpdateEntryTitle };

Default Value

""

Remarks

This property contains the title of the current Atom Feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

Data Type

String

UpdateEntryTitleTextType Property (Atom Component)

This property contains the text type of the title of the feed.

Syntax

__property TipwAtomUpdateEntryTitleTextTypes UpdateEntryTitleTextType = { read=FUpdateEntryTitleTextType, write=FSetUpdateEntryTitleTextType };

enum TipwAtomUpdateEntryTitleTextTypes {
  ttText=0,
  ttHTML=1,
  ttXHTML=2
};

Default Value

ttText

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

UpdateEntryUpdated Property (Atom Component)

This property contains the date and time that the feed was updated.

Syntax

__property String UpdateEntryUpdated = { read=FUpdateEntryUpdated, write=FSetUpdateEntryUpdated };

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

Data Type

String

UpdateFile Property (Atom Component)

This is a resource to be updated, deleted, or created.

Syntax

__property String UpdateFile = { read=FUpdateFile, write=FSetUpdateFile };

Default Value

""

Remarks

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is set to a local file, the content of that file will be used to form the content of the HTTP request.

Data Type

String

User Property (Atom Component)

This property includes a user name if authentication is to be used.

Syntax

__property String User = { read=FUser, write=FSetUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Data Type

String

AddCookie Method (Atom Component)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

void __fastcall AddCookie(String CookieName, String CookieValue);

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddNamespace Method (Atom Component)

This method adds a namespace to the Namespaces properties.

Syntax

void __fastcall AddNamespace(String Prefix, String NamespaceURI);

Remarks

This method is used to add a namespace to the Namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Config Method (Atom Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeleteResource Method (Atom Component)

This method deletes the resource at the specified URL.

Syntax

void __fastcall DeleteResource(String URL);

Remarks

The component will delete a resource at the specified URL.

DoEvents Method (Atom Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetFeed Method (Atom Component)

This method fetches an Atom feed.

Syntax

void __fastcall GetFeed(String URL);

Remarks

This method fetches the document. The document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers through the Header event.

Then the component will attempt to parse the Atom feed, filling in the Channel and Entries properties as it goes. The Channel properties also can be accessed using the GetProperty and SetProperty methods, if necessary.

GetProperty Method (Atom Component)

This method fetches the value of a specific Atom feed element or attribute.

Syntax

String __fastcall GetProperty(String PropertyName);

Remarks

This method is intended for extending functionality of the Atom component. It will fetch the value for a specific entry element or attribute of this Atom feed. Property is the XPath of the element or attribute according to the following convention: /feed/element@attribute or entry[x]/element@attribute. The @attribute part is optional.

entry[x] is the Channel's xth entry (or any other root-level child), where the indexer x starts at 1.

element is any child of the Channel or an entry, and attribute can be any attribute of that field. If an attribute is not supplied, the GetProperty method will return the text portion of element. For example:

AtomControl.GetProperty("entry[5]/link@href") AtomControl.GetProperty("entry[5]/author/name") AtomControl.GetProperty("/feed/title")

Note: To add nonstandard fields (i.e., fields that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

GetResource Method (Atom Component)

This method fetches a resource.

Syntax

void __fastcall GetResource(String URL);

Remarks

This method fetches the resource. If LocalFile is set, the document will be saved in the specified file. Otherwise, the document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers are delivered through the Header event.

Unlike the GetFeed method, after retrieval, the component will not attempt to parse the data into the Channel and Entries properties.

Interrupt Method (Atom Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

PostResource Method (Atom Component)

This method posts a resource to the specified URL.

Syntax

void __fastcall PostResource(String URL);

Remarks

This method will post a resource to the specified URL. It will either post a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

Put Method (Atom Component)

This method sends data to the HTTP server using the HTTP PUT method.

Syntax

void __fastcall Put(String URL);

Remarks

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

PutResource Method (Atom Component)

This method puts a resource to the specified URL.

Syntax

void __fastcall PutResource(String URL);

Remarks

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

ReadFile Method (Atom Component)

This method loads an Atom file into the component.

Syntax

void __fastcall ReadFile(String FileName);

Remarks

This method loads an Atom file and attempts to parse it, filling in the Channel and Entries properties as it goes. The Channel properties also can be accessed using the GetProperty and SetProperty methods if necessary.

Reset Method (Atom Component)

This method resets all properties of the component.

Syntax

void __fastcall Reset();

Remarks

This method resets all properties to the component's default settings. This is an easy way to clear all of the property values before repopulating the Atom feed.

SetProperty Method (Atom Component)

This method sets the value of a specific Atom feed property.

Syntax

void __fastcall SetProperty(String PropertyName, String PropertyValue);

Remarks

This method is intended for extending functionality of the Atom component. It will set the value for a specific field of this Atom feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be either of the two following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element. For example:

AtomControl.SetProperty("entry[5]/link@type", "text/html")

Note: To add nonstandard fields (i.e., fields that are not defined in the Atom specification), element must be prefixed with a Namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list Namespaces.

WriteFile Method (Atom Component)

This method is used to write an Atom feed from the component.

Syntax

void __fastcall WriteFile(String Filename);

Remarks

This method will write an Atom feed from the existing property values to Filename. The Atom feed will be pre-verified, and if any missing required fields are encountered, the component raises an exception.

Example (Add an Item and Write)

AtomControl.EntryCount = 1 AtomControl.EntryContent(0) = "New Item Description" AtomControl.EntryLinkHref(0) = "http://itemurl" AtomControl.WriteFile(filename)

Connected Event (Atom Component)

This event is fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TipwAtomConnectedEventParams;
typedef void __fastcall (__closure *TipwAtomConnectedEvent)(System::TObject* Sender, TipwAtomConnectedEventParams *e);
__property TipwAtomConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Atom Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TipwAtomConnectionStatusEventParams;
typedef void __fastcall (__closure *TipwAtomConnectionStatusEvent)(System::TObject* Sender, TipwAtomConnectionStatusEventParams *e);
__property TipwAtomConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (Atom Component)

This event is fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TipwAtomDisconnectedEventParams;
typedef void __fastcall (__closure *TipwAtomDisconnectedEvent)(System::TObject* Sender, TipwAtomDisconnectedEventParams *e);
__property TipwAtomDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (Atom Component)

This event fires when a document finishes transferring.

Syntax

typedef struct {
  int Direction;
} TipwAtomEndTransferEventParams;
typedef void __fastcall (__closure *TipwAtomEndTransferEvent)(System::TObject* Sender, TipwAtomEndTransferEventParams *e);
__property TipwAtomEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (Atom Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipwAtomErrorEventParams;
typedef void __fastcall (__closure *TipwAtomErrorEvent)(System::TObject* Sender, TipwAtomErrorEventParams *e);
__property TipwAtomErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (Atom Component)

This event is fired every time a header line comes in.

Syntax

typedef struct {
  String Field;
  String Value;
} TipwAtomHeaderEventParams;
typedef void __fastcall (__closure *TipwAtomHeaderEvent)(System::TObject* Sender, TipwAtomHeaderEventParams *e);
__property TipwAtomHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (Atom Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TipwAtomLogEventParams;
typedef void __fastcall (__closure *TipwAtomLogEvent)(System::TObject* Sender, TipwAtomLogEventParams *e);
__property TipwAtomLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (Atom Component)

This event is fired when a redirection is received from the server.

Syntax

typedef struct {
  String Location;
  bool Accept;
} TipwAtomRedirectEventParams;
typedef void __fastcall (__closure *TipwAtomRedirectEvent)(System::TObject* Sender, TipwAtomRedirectEventParams *e);
__property TipwAtomRedirectEvent OnRedirect = { read=FOnRedirect, write=FOnRedirect };

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component raises an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Atom Component)

This event is fired for every cookie set by the server.

Syntax

typedef struct {
  String Name;
  String Value;
  String Expires;
  String Domain;
  String Path;
  bool Secure;
} TipwAtomSetCookieEventParams;
typedef void __fastcall (__closure *TipwAtomSetCookieEvent)(System::TObject* Sender, TipwAtomSetCookieEventParams *e);
__property TipwAtomSetCookieEvent OnSetCookie = { read=FOnSetCookie, write=FOnSetCookie };

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (Atom Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TipwAtomSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TipwAtomSSLServerAuthenticationEvent)(System::TObject* Sender, TipwAtomSSLServerAuthenticationEventParams *e);
__property TipwAtomSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Atom Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TipwAtomSSLStatusEventParams;
typedef void __fastcall (__closure *TipwAtomSSLStatusEvent)(System::TObject* Sender, TipwAtomSSLStatusEventParams *e);
__property TipwAtomSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (Atom Component)

This event fires when a document starts transferring (after the headers).

Syntax

typedef struct {
  int Direction;
} TipwAtomStartTransferEventParams;
typedef void __fastcall (__closure *TipwAtomStartTransferEvent)(System::TObject* Sender, TipwAtomStartTransferEventParams *e);
__property TipwAtomStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (Atom Component)

This event is fired when the HTTP status line is received from the server.

Syntax

typedef struct {
  String HTTPVersion;
  int StatusCode;
  String Description;
} TipwAtomStatusEventParams;
typedef void __fastcall (__closure *TipwAtomStatusEvent)(System::TObject* Sender, TipwAtomStatusEventParams *e);
__property TipwAtomStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (Atom Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TipwAtomTransferEventParams;
typedef void __fastcall (__closure *TipwAtomTransferEvent)(System::TObject* Sender, TipwAtomTransferEventParams *e);
__property TipwAtomTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (Atom Component)

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (Atom Component)

ATOM Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors