IP*Works! atom Component : atom OCX, atom .NET Component, atom Class, atom Bean, atom Object

login

Red Carpet Subscriptions

IP*Works! Products

IBiz - Internet Business

QuickBooks Integrator

E-Payment Integrator

Vital/TSYS Integrator

Paymentech Integrator

Enterprise Adapters

SQL Server SSIS Tasks

Verified By Visa

3-D Secure MPI

Testimonials

"I have developed several internet applications using your IPPORT and UDPPORT. You have done a great job in offering a simple interface to IP from VB. Good work!"

-- T. Chumak

[more...]

Available in: IP*WORKS!

Atom Class

Atom Component [IP*Works! V8]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The Atom component implements a standard Atom reader 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" draft (http://www.ietf.org/internet-drafts/draft-ietf-atompub-protocol-15.txt).

The component contains a number of properties that map directly to Atom fields. To receive a feed call the GetFeed method with the URL or file to retrieve specified in the URL parameter. You may also update Atom collections using Get, Put, Post and Delete.

The Atom component supports all standard Atom properties and allows you to use your own using the Namespaces collection and the GetProperty and SetProperty methods.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Accept	A list of acceptable MIME types for the request.
AtomData	The complete content of the Atom resource.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Channel	The root level of an atom feed.
Connected	Shows whether the component is connected.
ContentType	Content type for posted data.
Cookies	Collection of cookies.
Entries	A collection of entries in the current Atom feed.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
IfModifiedSince	A date determining the maximum age of the desired document.
LocalFile	The path to a local file for downloading. If the file exists, it is overwritten. (optional)
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Namespaces	A collection of namespaces in the current namespace stack.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last retrieval.
Password	A password if authentication is to be used.
Proxy	A set of properties related to proxy access.
Referer	Referer URL/document (optional).
Slug	A header added to the HTTP request.
Timeout	A timeout for the component.
TransferredData	The contents of the last transfer.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
UpdateEntry	An Atom entry to be updated, deleted or created.
UpdateFile	A resource to be updated, deleted or created.
User	A user name if authentication is to be used.

Method List

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


AddCookie	Sets a cookie and the corresponding value.
AddNamespace	Adds a namespace to the Namespaces collection.
Config	Sets or retrieves a component configuration setting.
DeleteResource	Deletes a resource from specified URL.
DoEvents	Processes events from the internal message queue.
GetFeed	Fetch an Atom feed.
GetProperty	Get the value of a specific Atom feed element or attribute.
GetResource	Fetch an ATOM resource.
Interrupt	Interrupt the current method.
PostResource	Posts a resource to the specified URL.
Put	Sends data to the HTTP server using the HTTP PUT method.
PutResource	Puts a resource to the specified URL.
ReadFile	Load an Atom file into the component.
Reset	Reset all properties of the component.
SetProperty	Set the value of a specific Atom feed property.
WriteFile	Write an Atom feed from the component.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxEntries	Instructs component to save the amount of specified that are parsed from the atom feed.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SocketHandle	The handle of the main socket used by the component.
TcpNoDelay	Whether or not to delay when sending packets
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UserAgent	Information about the user agent (browser).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)

|

About

|

Privacy Policy

|

Terms of Use

|