Atom Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworks.Atom

Remarks

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

The Atom Class 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 class contains a number of properties that map directly to Atom fields. To receive a feed, call the get_feed 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 Class supports all standard Atom properties and allows you to add your own through add_namespace and the get_property and set_property methods.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

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

accept Property

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

Syntax

def get_accept() -> str: ...
def set_accept(value: str) -> None: ...

accept = property(get_accept, set_accept)

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.

atom_data Property

This is the complete content of the Atom resource.

Syntax

def get_atom_data() -> bytes: ...
def set_atom_data(value: bytes) -> None: ...

atom_data = property(get_atom_data, set_atom_data)

Default Value

""

Remarks

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

authorization Property

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

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme 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]".

auth_scheme Property

The authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class 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 class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

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

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

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

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

channel_author_email Property

This property contains the email address of the author.

Syntax

def get_channel_author_email() -> str: ...
def set_channel_author_email(value: str) -> None: ...

channel_author_email = property(get_channel_author_email, set_channel_author_email)

Default Value

""

Remarks

This property contains the email address of the author.

channel_author_name Property

This property contains the name of the author.

Syntax

def get_channel_author_name() -> str: ...
def set_channel_author_name(value: str) -> None: ...

channel_author_name = property(get_channel_author_name, set_channel_author_name)

Default Value

""

Remarks

This property contains the name of the author.

channel_author_uri Property

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

Syntax

def get_channel_author_uri() -> str: ...
def set_channel_author_uri(value: str) -> None: ...

channel_author_uri = property(get_channel_author_uri, set_channel_author_uri)

Default Value

""

Remarks

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

channel_category_label Property

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

Syntax

def get_channel_category_label() -> str: ...
def set_channel_category_label(value: str) -> None: ...

channel_category_label = property(get_channel_category_label, set_channel_category_label)

Default Value

""

Remarks

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

channel_category_scheme Property

This property identifies a categorization scheme.

Syntax

def get_channel_category_scheme() -> str: ...
def set_channel_category_scheme(value: str) -> None: ...

channel_category_scheme = property(get_channel_category_scheme, set_channel_category_scheme)

Default Value

""

Remarks

This property identifies a categorization scheme.

channel_category_term Property

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

Syntax

def get_channel_category_term() -> str: ...
def set_channel_category_term(value: str) -> None: ...

channel_category_term = property(get_channel_category_term, set_channel_category_term)

Default Value

""

Remarks

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

channel_contributor_email Property

This property contains the email address of the contributor.

Syntax

def get_channel_contributor_email() -> str: ...
def set_channel_contributor_email(value: str) -> None: ...

channel_contributor_email = property(get_channel_contributor_email, set_channel_contributor_email)

Default Value

""

Remarks

This property contains the email address of the contributor.

channel_contributor_name Property

This property contains the name of the contributor.

Syntax

def get_channel_contributor_name() -> str: ...
def set_channel_contributor_name(value: str) -> None: ...

channel_contributor_name = property(get_channel_contributor_name, set_channel_contributor_name)

Default Value

""

Remarks

This property contains the name of the contributor.

channel_contributor_uri Property

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

Syntax

def get_channel_contributor_uri() -> str: ...
def set_channel_contributor_uri(value: str) -> None: ...

channel_contributor_uri = property(get_channel_contributor_uri, set_channel_contributor_uri)

Default Value

""

Remarks

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

channel_generator Property

This property identifies the generator of the feed.

Syntax

def get_channel_generator() -> str: ...
def set_channel_generator(value: str) -> None: ...

channel_generator = property(get_channel_generator, set_channel_generator)

Default Value

""

Remarks

This property identifies the generator of the feed.

channel_icon Property

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

Syntax

def get_channel_icon() -> str: ...
def set_channel_icon(value: str) -> None: ...

channel_icon = property(get_channel_icon, set_channel_icon)

Default Value

""

Remarks

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

channel_id Property

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

Syntax

def get_channel_id() -> str: ...
def set_channel_id(value: str) -> None: ...

channel_id = property(get_channel_id, set_channel_id)

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.

channel_link_href Property

This property contains the location of the link.

Syntax

def get_channel_link_href() -> str: ...
def set_channel_link_href(value: str) -> None: ...

channel_link_href = property(get_channel_link_href, set_channel_link_href)

Default Value

""

Remarks

This property contains the location of the link.

channel_link_href_lang Property

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

Syntax

def get_channel_link_href_lang() -> str: ...
def set_channel_link_href_lang(value: str) -> None: ...

channel_link_href_lang = property(get_channel_link_href_lang, set_channel_link_href_lang)

Default Value

""

Remarks

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

channel_link_length Property

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

Syntax

def get_channel_link_length() -> str: ...
def set_channel_link_length(value: str) -> None: ...

channel_link_length = property(get_channel_link_length, set_channel_link_length)

Default Value

""

Remarks

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

channel_link_rel Property

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

Syntax

def get_channel_link_rel() -> str: ...
def set_channel_link_rel(value: str) -> None: ...

channel_link_rel = property(get_channel_link_rel, set_channel_link_rel)

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

channel_link_title Property

This property contains the title of the link.

Syntax

def get_channel_link_title() -> str: ...
def set_channel_link_title(value: str) -> None: ...

channel_link_title = property(get_channel_link_title, set_channel_link_title)

Default Value

""

Remarks

This property contains the title of the link.

channel_link_type Property

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

Syntax

def get_channel_link_type() -> str: ...
def set_channel_link_type(value: str) -> None: ...

channel_link_type = property(get_channel_link_type, set_channel_link_type)

Default Value

""

Remarks

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

channel_logo Property

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

Syntax

def get_channel_logo() -> str: ...
def set_channel_logo(value: str) -> None: ...

channel_logo = property(get_channel_logo, set_channel_logo)

Default Value

""

Remarks

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

channel_rights Property

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

Syntax

def get_channel_rights() -> str: ...
def set_channel_rights(value: str) -> None: ...

channel_rights = property(get_channel_rights, set_channel_rights)

Default Value

""

Remarks

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

channel_rights_text_type Property

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

Syntax

def get_channel_rights_text_type() -> int: ...
def set_channel_rights_text_type(value: int) -> None: ...

channel_rights_text_type = property(get_channel_rights_text_type, set_channel_rights_text_type)

Default Value

0

Remarks

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

channel_subtitle Property

This property contains a short description of the Atom feed.

Syntax

def get_channel_subtitle() -> str: ...
def set_channel_subtitle(value: str) -> None: ...

channel_subtitle = property(get_channel_subtitle, set_channel_subtitle)

Default Value

""

Remarks

This property contains a short description of the Atom feed.

channel_subtitle_text_type Property

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

Syntax

def get_channel_subtitle_text_type() -> int: ...
def set_channel_subtitle_text_type(value: int) -> None: ...

channel_subtitle_text_type = property(get_channel_subtitle_text_type, set_channel_subtitle_text_type)

Default Value

0

Remarks

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

channel_title Property

This property contains the title of the current Atom feed.

Syntax

def get_channel_title() -> str: ...
def set_channel_title(value: str) -> None: ...

channel_title = property(get_channel_title, set_channel_title)

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.

channel_title_text_type Property

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

Syntax

def get_channel_title_text_type() -> int: ...
def set_channel_title_text_type(value: int) -> None: ...

channel_title_text_type = property(get_channel_title_text_type, set_channel_title_text_type)

Default Value

0

Remarks

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

channel_updated Property

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

Syntax

def get_channel_updated() -> str: ...
def set_channel_updated(value: str) -> None: ...

channel_updated = property(get_channel_updated, set_channel_updated)

Default Value

""

Remarks

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

connected Property

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

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

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

content_type Property

This is the content type for posts and puts.

Syntax

def get_content_type() -> str: ...
def set_content_type(value: str) -> None: ...

content_type = property(get_content_type, set_content_type)

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 post_resource or put_resource to the server.

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

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

cookie_domain Property

This is the domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

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 url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

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

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

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 cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

This property, contains the name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property, contains the name of the cookie.

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

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

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

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

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 url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

This property contains the security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

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 cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

This property contains the value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

entry_count Property

The number of records in the Entry arrays.

Syntax

def get_entry_count() -> int: ...
def set_entry_count(value: int) -> None: ...

entry_count = property(get_entry_count, set_entry_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• entry_author_email
• entry_author_name
• entry_author_uri
• entry_category_label
• entry_category_scheme
• entry_category_term
• entry_content
• entry_content_text_type
• entry_contributor_email
• entry_contributor_name
• entry_contributor_uri
• entry_copyright
• entry_created
• entry_id
• entry_issued
• entry_link_href
• entry_link_href_lang
• entry_link_length
• entry_link_rel
• entry_link_title
• entry_link_type
• entry_modified
• entry_published
• entry_rights
• entry_rights_text_type
• entry_source
• entry_summary
• entry_summary_text_type
• entry_title
• entry_title_text_type
• entry_updated
• entry_xml

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

entry_author_email Property

This property contains the email address of the author.

Syntax

def get_entry_author_email(entry_index: int) -> str: ...
def set_entry_author_email(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the email address of the author.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_author_name Property

This property contains the name of the author.

Syntax

def get_entry_author_name(entry_index: int) -> str: ...
def set_entry_author_name(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the author.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_author_uri Property

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

Syntax

def get_entry_author_uri(entry_index: int) -> str: ...
def set_entry_author_uri(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_category_label Property

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

Syntax

def get_entry_category_label(entry_index: int) -> str: ...
def set_entry_category_label(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_category_scheme Property

This property identifies a categorization scheme.

Syntax

def get_entry_category_scheme(entry_index: int) -> str: ...
def set_entry_category_scheme(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property identifies a categorization scheme.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_category_term Property

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

Syntax

def get_entry_category_term(entry_index: int) -> str: ...
def set_entry_category_term(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_content Property

This property contains the text contents of an Atom entry.

Syntax

def get_entry_content(entry_index: int) -> str: ...
def set_entry_content(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_content_text_type Property

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

Syntax

def get_entry_content_text_type(entry_index: int) -> int: ...
def set_entry_content_text_type(entry_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_contributor_email Property

This property contains the email address of the contributor.

Syntax

def get_entry_contributor_email(entry_index: int) -> str: ...
def set_entry_contributor_email(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the email address of the contributor.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_contributor_name Property

This property contains the name of the contributor.

Syntax

def get_entry_contributor_name(entry_index: int) -> str: ...
def set_entry_contributor_name(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the contributor.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_contributor_uri Property

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

Syntax

def get_entry_contributor_uri(entry_index: int) -> str: ...
def set_entry_contributor_uri(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_copyright Property

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

Syntax

def get_entry_copyright(entry_index: int) -> str: ...
def set_entry_copyright(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_created Property

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

Syntax

def get_entry_created(entry_index: int) -> str: ...
def set_entry_created(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_xml Property

This property contains the full XML contents of the entry.

Syntax

def get_entry_xml(entry_index: int) -> str: ...
def set_entry_xml(entry_index: int, value: str) -> None: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_id Property

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

Syntax

def get_entry_id(entry_index: int) -> str: ...
def set_entry_id(entry_index: int, value: str) -> None: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_issued Property

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

Syntax

def get_entry_issued(entry_index: int) -> str: ...
def set_entry_issued(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_href Property

This property contains the location of the link.

Syntax

def get_entry_link_href(entry_index: int) -> str: ...
def set_entry_link_href(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the location of the link.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_href_lang Property

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

Syntax

def get_entry_link_href_lang(entry_index: int) -> str: ...
def set_entry_link_href_lang(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_length Property

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

Syntax

def get_entry_link_length(entry_index: int) -> str: ...
def set_entry_link_length(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_rel Property

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

Syntax

def get_entry_link_rel(entry_index: int) -> str: ...
def set_entry_link_rel(entry_index: int, value: str) -> None: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_title Property

This property contains the title of the link.

Syntax

def get_entry_link_title(entry_index: int) -> str: ...
def set_entry_link_title(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the title of the link.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_link_type Property

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

Syntax

def get_entry_link_type(entry_index: int) -> str: ...
def set_entry_link_type(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_modified Property

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

Syntax

def get_entry_modified(entry_index: int) -> str: ...
def set_entry_modified(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_published Property

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

Syntax

def get_entry_published(entry_index: int) -> str: ...
def set_entry_published(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_rights Property

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

Syntax

def get_entry_rights(entry_index: int) -> str: ...
def set_entry_rights(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_rights_text_type Property

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

Syntax

def get_entry_rights_text_type(entry_index: int) -> int: ...
def set_entry_rights_text_type(entry_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_source Property

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

Syntax

def get_entry_source(entry_index: int) -> str: ...
def set_entry_source(entry_index: int, value: str) -> None: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_summary Property

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

Syntax

def get_entry_summary(entry_index: int) -> str: ...
def set_entry_summary(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_summary_text_type Property

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

Syntax

def get_entry_summary_text_type(entry_index: int) -> int: ...
def set_entry_summary_text_type(entry_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_title Property

This property contains the title of the current Atom Feed.

Syntax

def get_entry_title(entry_index: int) -> str: ...
def set_entry_title(entry_index: int, value: str) -> None: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_title_text_type Property

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

Syntax

def get_entry_title_text_type(entry_index: int) -> int: ...
def set_entry_title_text_type(entry_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

entry_updated Property

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

Syntax

def get_entry_updated(entry_index: int) -> str: ...
def set_entry_updated(entry_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_count property.

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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 class fails with an error.

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

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

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class 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 url_scheme is the same; otherwise, the class fails with an error.

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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 class fails with an error instead.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

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.

if_modified_since Property

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

Syntax

def get_if_modified_since() -> str: ...
def set_if_modified_since(value: str) -> None: ...

if_modified_since = property(get_if_modified_since, set_if_modified_since)

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 class fails with an error

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

local_file Property

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

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property is used when getting a document.

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

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

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

namespace_prefix Property

The Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

The namespace_prefix for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

Namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

other_headers Property

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

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

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 content_type 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 class beyond what is provided.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

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

This property is read-only.

parsed_header_field Property

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

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

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

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

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

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

referer Property

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

Syntax

def get_referer() -> str: ...
def set_referer(value: str) -> None: ...

referer = property(get_referer, set_referer)

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.

slug Property

A header added to the HTTP request.

Syntax

def get_slug() -> str: ...
def set_slug(value: str) -> None: ...

slug = property(get_slug, set_slug)

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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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 class will wait for the operation to complete before returning control.

The class will use do_events 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 class fails with an error.

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.

transferred_data Property

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

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

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

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

This property is read-only.

transferred_data_limit Property

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

Syntax

def get_transferred_data_limit() -> int: ...
def set_transferred_data_limit(value: int) -> None: ...

transferred_data_limit = property(get_transferred_data_limit, set_transferred_data_limit)

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 class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

transferred_headers Property

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

Syntax

def get_transferred_headers() -> str: ...

transferred_headers = property(get_transferred_headers, None)

Default Value

""

Remarks

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

The on_header event shows the individual headers as parsed by the class.

This property is read-only.

update_entry_author_email Property

This property contains the email address of the author.

Syntax

def get_update_entry_author_email() -> str: ...
def set_update_entry_author_email(value: str) -> None: ...

update_entry_author_email = property(get_update_entry_author_email, set_update_entry_author_email)

Default Value

""

Remarks

This property contains the email address of the author.

update_entry_author_name Property

This property contains the name of the author.

Syntax

def get_update_entry_author_name() -> str: ...
def set_update_entry_author_name(value: str) -> None: ...

update_entry_author_name = property(get_update_entry_author_name, set_update_entry_author_name)

Default Value

""

Remarks

This property contains the name of the author.

update_entry_author_uri Property

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

Syntax

def get_update_entry_author_uri() -> str: ...
def set_update_entry_author_uri(value: str) -> None: ...

update_entry_author_uri = property(get_update_entry_author_uri, set_update_entry_author_uri)

Default Value

""

Remarks

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

update_entry_category_label Property

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

Syntax

def get_update_entry_category_label() -> str: ...
def set_update_entry_category_label(value: str) -> None: ...

update_entry_category_label = property(get_update_entry_category_label, set_update_entry_category_label)

Default Value

""

Remarks

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

update_entry_category_scheme Property

This property identifies a categorization scheme.

Syntax

def get_update_entry_category_scheme() -> str: ...
def set_update_entry_category_scheme(value: str) -> None: ...

update_entry_category_scheme = property(get_update_entry_category_scheme, set_update_entry_category_scheme)

Default Value

""

Remarks

This property identifies a categorization scheme.

update_entry_category_term Property

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

Syntax

def get_update_entry_category_term() -> str: ...
def set_update_entry_category_term(value: str) -> None: ...

update_entry_category_term = property(get_update_entry_category_term, set_update_entry_category_term)

Default Value

""

Remarks

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

update_entry_content Property

This property contains the text contents of an Atom entry.

Syntax

def get_update_entry_content() -> str: ...
def set_update_entry_content(value: str) -> None: ...

update_entry_content = property(get_update_entry_content, set_update_entry_content)

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

update_entry_content_text_type Property

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

Syntax

def get_update_entry_content_text_type() -> int: ...
def set_update_entry_content_text_type(value: int) -> None: ...

update_entry_content_text_type = property(get_update_entry_content_text_type, set_update_entry_content_text_type)

Default Value

0

Remarks

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

update_entry_contributor_email Property

This property contains the email address of the contributor.

Syntax

def get_update_entry_contributor_email() -> str: ...
def set_update_entry_contributor_email(value: str) -> None: ...

update_entry_contributor_email = property(get_update_entry_contributor_email, set_update_entry_contributor_email)

Default Value

""

Remarks

This property contains the email address of the contributor.

update_entry_contributor_name Property

This property contains the name of the contributor.

Syntax

def get_update_entry_contributor_name() -> str: ...
def set_update_entry_contributor_name(value: str) -> None: ...

update_entry_contributor_name = property(get_update_entry_contributor_name, set_update_entry_contributor_name)

Default Value

""

Remarks

This property contains the name of the contributor.

update_entry_contributor_uri Property

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

Syntax

def get_update_entry_contributor_uri() -> str: ...
def set_update_entry_contributor_uri(value: str) -> None: ...

update_entry_contributor_uri = property(get_update_entry_contributor_uri, set_update_entry_contributor_uri)

Default Value

""

Remarks

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

update_entry_copyright Property

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

Syntax

def get_update_entry_copyright() -> str: ...
def set_update_entry_copyright(value: str) -> None: ...

update_entry_copyright = property(get_update_entry_copyright, set_update_entry_copyright)

Default Value

""

Remarks

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

update_entry_created Property

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

Syntax

def get_update_entry_created() -> str: ...
def set_update_entry_created(value: str) -> None: ...

update_entry_created = property(get_update_entry_created, set_update_entry_created)

Default Value

""

Remarks

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

update_entry_xml Property

This property contains the full XML contents of the entry.

Syntax

def get_update_entry_xml() -> str: ...
def set_update_entry_xml(value: str) -> None: ...

update_entry_xml = property(get_update_entry_xml, set_update_entry_xml)

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.

update_entry_id Property

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

Syntax

def get_update_entry_id() -> str: ...
def set_update_entry_id(value: str) -> None: ...

update_entry_id = property(get_update_entry_id, set_update_entry_id)

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.

update_entry_issued Property

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

Syntax

def get_update_entry_issued() -> str: ...
def set_update_entry_issued(value: str) -> None: ...

update_entry_issued = property(get_update_entry_issued, set_update_entry_issued)

Default Value

""

Remarks

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

update_entry_link_href Property

This property contains the location of the link.

Syntax

def get_update_entry_link_href() -> str: ...
def set_update_entry_link_href(value: str) -> None: ...

update_entry_link_href = property(get_update_entry_link_href, set_update_entry_link_href)

Default Value

""

Remarks

This property contains the location of the link.

update_entry_link_href_lang Property

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

Syntax

def get_update_entry_link_href_lang() -> str: ...
def set_update_entry_link_href_lang(value: str) -> None: ...

update_entry_link_href_lang = property(get_update_entry_link_href_lang, set_update_entry_link_href_lang)

Default Value

""

Remarks

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

update_entry_link_length Property

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

Syntax

def get_update_entry_link_length() -> str: ...
def set_update_entry_link_length(value: str) -> None: ...

update_entry_link_length = property(get_update_entry_link_length, set_update_entry_link_length)

Default Value

""

Remarks

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

update_entry_link_rel Property

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

Syntax

def get_update_entry_link_rel() -> str: ...
def set_update_entry_link_rel(value: str) -> None: ...

update_entry_link_rel = property(get_update_entry_link_rel, set_update_entry_link_rel)

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

update_entry_link_title Property

This property contains the title of the link.

Syntax

def get_update_entry_link_title() -> str: ...
def set_update_entry_link_title(value: str) -> None: ...

update_entry_link_title = property(get_update_entry_link_title, set_update_entry_link_title)

Default Value

""

Remarks

This property contains the title of the link.

update_entry_link_type Property

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

Syntax

def get_update_entry_link_type() -> str: ...
def set_update_entry_link_type(value: str) -> None: ...

update_entry_link_type = property(get_update_entry_link_type, set_update_entry_link_type)

Default Value

""

Remarks

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

update_entry_modified Property

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

Syntax

def get_update_entry_modified() -> str: ...
def set_update_entry_modified(value: str) -> None: ...

update_entry_modified = property(get_update_entry_modified, set_update_entry_modified)

Default Value

""

Remarks

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

update_entry_published Property

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

Syntax

def get_update_entry_published() -> str: ...
def set_update_entry_published(value: str) -> None: ...

update_entry_published = property(get_update_entry_published, set_update_entry_published)

Default Value

""

Remarks

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

update_entry_rights Property

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

Syntax

def get_update_entry_rights() -> str: ...
def set_update_entry_rights(value: str) -> None: ...

update_entry_rights = property(get_update_entry_rights, set_update_entry_rights)

Default Value

""

Remarks

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

update_entry_rights_text_type Property

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

Syntax

def get_update_entry_rights_text_type() -> int: ...
def set_update_entry_rights_text_type(value: int) -> None: ...

update_entry_rights_text_type = property(get_update_entry_rights_text_type, set_update_entry_rights_text_type)

Default Value

0

Remarks

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

update_entry_source Property

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

Syntax

def get_update_entry_source() -> str: ...
def set_update_entry_source(value: str) -> None: ...

update_entry_source = property(get_update_entry_source, set_update_entry_source)

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.

update_entry_summary Property

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

Syntax

def get_update_entry_summary() -> str: ...
def set_update_entry_summary(value: str) -> None: ...

update_entry_summary = property(get_update_entry_summary, set_update_entry_summary)

Default Value

""

Remarks

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

update_entry_summary_text_type Property

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

Syntax

def get_update_entry_summary_text_type() -> int: ...
def set_update_entry_summary_text_type(value: int) -> None: ...

update_entry_summary_text_type = property(get_update_entry_summary_text_type, set_update_entry_summary_text_type)

Default Value

0

Remarks

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

update_entry_title Property

This property contains the title of the current Atom Feed.

Syntax

def get_update_entry_title() -> str: ...
def set_update_entry_title(value: str) -> None: ...

update_entry_title = property(get_update_entry_title, set_update_entry_title)

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.

update_entry_title_text_type Property

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

Syntax

def get_update_entry_title_text_type() -> int: ...
def set_update_entry_title_text_type(value: int) -> None: ...

update_entry_title_text_type = property(get_update_entry_title_text_type, set_update_entry_title_text_type)

Default Value

0

Remarks

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

update_entry_updated Property

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

Syntax

def get_update_entry_updated() -> str: ...
def set_update_entry_updated(value: str) -> None: ...

update_entry_updated = property(get_update_entry_updated, set_update_entry_updated)

Default Value

""

Remarks

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

update_file Property

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

Syntax

def get_update_file() -> str: ...
def set_update_file(value: str) -> None: ...

update_file = property(get_update_file, set_update_file)

Default Value

""

Remarks

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

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

user Property

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

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

add_cookie Method

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

Syntax

def add_cookie(cookie_name: str, cookie_value: str) -> None: ...

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.

add_namespace Method

This method adds a namespace to the Namespaces properties.

Syntax

def add_namespace(prefix: str, namespace_uri: str) -> None: ...

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

delete_resource Method

This method deletes the resource at the specified URL.

Syntax

def delete_resource(url: str) -> None: ...

Remarks

The class will delete a resource at the specified URL.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

get_feed Method

This method fetches an Atom feed.

Syntax

def get_feed(url: str) -> None: ...

Remarks

This method fetches the document. The document contents are delivered in the atom_data property, as well as through the on_transfer event, and the HTTP response headers through the on_header event.

Then the class 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 get_property and set_property methods, if necessary.

get_property Method

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

Syntax

def get_property(property_name: str) -> str: ...

Remarks

This method is intended for extending functionality of the Atom class. 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 get_property 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.

get_resource Method

This method fetches a resource.

Syntax

def get_resource(url: str) -> None: ...

Remarks

This method fetches the resource. If local_file is set, the document will be saved in the specified file. Otherwise, the document contents are delivered in the atom_data property, as well as through the on_transfer event, and the HTTP response headers are delivered through the on_header event.

Unlike the get_feed method, after retrieval, the class will not attempt to parse the data into the channel and entries properties.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

post_resource Method

This method posts a resource to the specified URL.

Syntax

def post_resource(url: str) -> None: ...

Remarks

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

put Method

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

Syntax

def put(url: str) -> None: ...

Remarks

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

put_resource Method

This method puts a resource to the specified URL.

Syntax

def put_resource(url: str) -> None: ...

Remarks

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

read_file Method

This method loads an Atom file into the class.

Syntax

def read_file(file_name: str) -> None: ...

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 get_property and set_property methods if necessary.

reset Method

This method resets all properties of the class.

Syntax

def reset() -> None: ...

Remarks

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

set_property Method

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

Syntax

def set_property(property_name: str, property_value: str) -> None: ...

Remarks

This method is intended for extending functionality of the Atom class. 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.

write_file Method

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

Syntax

def write_file(filename: str) -> None: ...

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 class fails with an error.

Example (Add an Item and Write)

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

on_connected Event

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

Syntax

class AtomConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class Atom:
@property
def on_connected() -> Callable[[AtomConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[AtomConnectedEventParams], None]) -> None: ...

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.

on_connection_status Event

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

Syntax

class AtomConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class Atom:
@property
def on_connection_status() -> Callable[[AtomConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[AtomConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class AtomDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class Atom:
@property
def on_disconnected() -> Callable[[AtomDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[AtomDisconnectedEventParams], None]) -> None: ...

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.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class AtomEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class Atom:
@property
def on_end_transfer() -> Callable[[AtomEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[AtomEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer 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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class AtomErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Atom:
@property
def on_error() -> Callable[[AtomErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AtomErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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.

on_header Event

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

Syntax

class AtomHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class Atom:
@property
def on_header() -> Callable[[AtomHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[AtomHeaderEventParams], None]) -> None: ...

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).

on_log Event

This event fires once for each log message.

Syntax

class AtomLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class Atom:
@property
def on_log() -> Callable[[AtomLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AtomLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. 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"

on_redirect Event

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

Syntax

class AtomRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Atom:
@property
def on_redirect() -> Callable[[AtomRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[AtomRedirectEventParams], None]) -> None: ...

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 class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie Event

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

Syntax

class AtomSetCookieEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def expires() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def path() -> str: ...

  @property
  def secure() -> bool: ...

# In class Atom:
@property
def on_set_cookie() -> Callable[[AtomSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[AtomSetCookieEventParams], None]) -> None: ...

Remarks

The on_set_cookie 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 (url_server) 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 (url_path) 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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AtomSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Atom:
@property
def on_ssl_server_authentication() -> Callable[[AtomSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AtomSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class AtomSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class Atom:
@property
def on_ssl_status() -> Callable[[AtomSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AtomSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer Event

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

Syntax

class AtomStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class Atom:
@property
def on_start_transfer() -> Callable[[AtomStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[AtomStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.

on_status Event

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

Syntax

class AtomStatusEventParams(object):
  @property
  def http_version() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class Atom:
@property
def on_status() -> Callable[[AtomStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[AtomStatusEventParams], None]) -> None: ...

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").

on_transfer Event

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

Syntax

class AtomTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class Atom:
@property
def on_transfer() -> Callable[[AtomTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[AtomTransferEventParams], None]) -> None: ...

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.

Atom Config Settings

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

Atom Errors

ATOM Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors