RSS Module

Properties   Methods   Events   Config Settings   Errors  

The RSS Module is used to retrieve, parse, edit, and write RSS-syndicated content.

Syntax

IPWorks.Rss

Remarks

The RSS Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The RSS Class implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The class contains a number of properties that map directly to RSS fields. To receive a feed, call the GetFeed method with the URL or file to retrieve as specified in the URL parameter. The RSS class also can generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Class supports all RSS feed properties that are standard in versions 0.91, 0.92, and 2.0 of the RSS protocol through a number of class properties. It also supports nonstandard properties as specified in the RSS protocol through the Namespaces properties and the GetProperty and SetProperty methods.

Property List

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

Method List

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

Event List

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

Config Settings

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

Accept Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var accept: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accept,setter=setAccept:) NSString* accept;

- (NSString*)accept;
- (void)setAccept :(NSString*)newAccept;

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.

Authorization Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var authorization: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization :(NSString*)newAuthorization;

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

AuthScheme Property (RSS Module)

The authentication scheme to use when server authentication is required.

Syntax

• Swift
• Objective-C

public var authScheme: RssAuthSchemes {
  get {...}
  set {...}
}

public enum RssAuthSchemes: Int32 {
  case authBasic = 0
  case authDigest = 1
  case authProprietary = 2
  case authNone = 3
  case authNtlm = 4
  case authNegotiate = 5
  case authOAuth = 6
}

@property (nonatomic,readwrite,assign,getter=authScheme,setter=setAuthScheme:) int authScheme;

- (int)authScheme;
- (void)setAuthScheme :(int)newAuthScheme;

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 AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

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

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

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

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

Channel Property (RSS Module)

This property includes the channel data for the feed.

Syntax

• Swift
• Objective-C

public var channel: RSSChannel {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=channelCategory,setter=setChannelCategory:) NSString* channelCategory;

- (NSString*)channelCategory;
- (void)setChannelCategory :(NSString*)newChannelCategory;

@property (nonatomic,readwrite,assign,getter=channelCategoryDomain,setter=setChannelCategoryDomain:) NSString* channelCategoryDomain;

- (NSString*)channelCategoryDomain;
- (void)setChannelCategoryDomain :(NSString*)newChannelCategoryDomain;

@property (nonatomic,readwrite,assign,getter=channelCopyright,setter=setChannelCopyright:) NSString* channelCopyright;

- (NSString*)channelCopyright;
- (void)setChannelCopyright :(NSString*)newChannelCopyright;

@property (nonatomic,readwrite,assign,getter=channelDescription,setter=setChannelDescription:) NSString* channelDescription;

- (NSString*)channelDescription;
- (void)setChannelDescription :(NSString*)newChannelDescription;

@property (nonatomic,readwrite,assign,getter=channelDocs,setter=setChannelDocs:) NSString* channelDocs;

- (NSString*)channelDocs;
- (void)setChannelDocs :(NSString*)newChannelDocs;

@property (nonatomic,readwrite,assign,getter=channelGenerator,setter=setChannelGenerator:) NSString* channelGenerator;

- (NSString*)channelGenerator;
- (void)setChannelGenerator :(NSString*)newChannelGenerator;

@property (nonatomic,readwrite,assign,getter=channelImageDescription,setter=setChannelImageDescription:) NSString* channelImageDescription;

- (NSString*)channelImageDescription;
- (void)setChannelImageDescription :(NSString*)newChannelImageDescription;

@property (nonatomic,readwrite,assign,getter=channelImageHeight,setter=setChannelImageHeight:) NSString* channelImageHeight;

- (NSString*)channelImageHeight;
- (void)setChannelImageHeight :(NSString*)newChannelImageHeight;

@property (nonatomic,readwrite,assign,getter=channelImageLink,setter=setChannelImageLink:) NSString* channelImageLink;

- (NSString*)channelImageLink;
- (void)setChannelImageLink :(NSString*)newChannelImageLink;

@property (nonatomic,readwrite,assign,getter=channelImageTitle,setter=setChannelImageTitle:) NSString* channelImageTitle;

- (NSString*)channelImageTitle;
- (void)setChannelImageTitle :(NSString*)newChannelImageTitle;

@property (nonatomic,readwrite,assign,getter=channelImageUrl,setter=setChannelImageUrl:) NSString* channelImageUrl;

- (NSString*)channelImageUrl;
- (void)setChannelImageUrl :(NSString*)newChannelImageUrl;

@property (nonatomic,readwrite,assign,getter=channelImageWidth,setter=setChannelImageWidth:) NSString* channelImageWidth;

- (NSString*)channelImageWidth;
- (void)setChannelImageWidth :(NSString*)newChannelImageWidth;

@property (nonatomic,readwrite,assign,getter=channelLanguage,setter=setChannelLanguage:) NSString* channelLanguage;

- (NSString*)channelLanguage;
- (void)setChannelLanguage :(NSString*)newChannelLanguage;

@property (nonatomic,readwrite,assign,getter=channelLastBuildDate,setter=setChannelLastBuildDate:) NSString* channelLastBuildDate;

- (NSString*)channelLastBuildDate;
- (void)setChannelLastBuildDate :(NSString*)newChannelLastBuildDate;

@property (nonatomic,readwrite,assign,getter=channelLink,setter=setChannelLink:) NSString* channelLink;

- (NSString*)channelLink;
- (void)setChannelLink :(NSString*)newChannelLink;

@property (nonatomic,readwrite,assign,getter=channelManagingEditor,setter=setChannelManagingEditor:) NSString* channelManagingEditor;

- (NSString*)channelManagingEditor;
- (void)setChannelManagingEditor :(NSString*)newChannelManagingEditor;

@property (nonatomic,readwrite,assign,getter=channelPubDate,setter=setChannelPubDate:) NSString* channelPubDate;

- (NSString*)channelPubDate;
- (void)setChannelPubDate :(NSString*)newChannelPubDate;

@property (nonatomic,readwrite,assign,getter=channelSkipDays,setter=setChannelSkipDays:) NSString* channelSkipDays;

- (NSString*)channelSkipDays;
- (void)setChannelSkipDays :(NSString*)newChannelSkipDays;

@property (nonatomic,readwrite,assign,getter=channelSkipHours,setter=setChannelSkipHours:) NSString* channelSkipHours;

- (NSString*)channelSkipHours;
- (void)setChannelSkipHours :(NSString*)newChannelSkipHours;

@property (nonatomic,readwrite,assign,getter=channelTitle,setter=setChannelTitle:) NSString* channelTitle;

- (NSString*)channelTitle;
- (void)setChannelTitle :(NSString*)newChannelTitle;

@property (nonatomic,readwrite,assign,getter=channelTtl,setter=setChannelTtl:) NSString* channelTtl;

- (NSString*)channelTtl;
- (void)setChannelTtl :(NSString*)newChannelTtl;

@property (nonatomic,readwrite,assign,getter=channelWebMaster,setter=setChannelWebMaster:) NSString* channelWebMaster;

- (NSString*)channelWebMaster;
- (void)setChannelWebMaster :(NSString*)newChannelWebMaster;

 

Default Value

""

Remarks

This property contains fields that contain values for subelements of the RSS Channel.

Connected Property (RSS Module)

This shows whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

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.

Cookies Property (RSS Module)

This property includes a collection of cookies.

Syntax

• Swift
• Objective-C

public var cookies: Array<HTTPCookie> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=cookieCount,setter=setCookieCount:) int cookieCount;

- (int)cookieCount;
- (void)setCookieCount :(int)newCookieCount;

- (NSString*)cookieDomain:(int)cookieIndex;

- (NSString*)cookieExpiration:(int)cookieIndex;

- (NSString*)cookieName:(int)cookieIndex;
- (void)setCookieName:(int)cookieIndex :(NSString*)newCookieName;

- (NSString*)cookiePath:(int)cookieIndex;

- (BOOL)cookieSecure:(int)cookieIndex;

- (NSString*)cookieValue:(int)cookieIndex;
- (void)setCookieValue:(int)cookieIndex :(NSString*)newCookieValue;

Default Value

""

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

Firewall Property (RSS Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

FollowRedirects Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var followRedirects: RssFollowRedirects {
  get {...}
  set {...}
}

public enum RssFollowRedirects: Int32 {
  case frNever = 0
  case frAlways = 1
  case frSameScheme = 2
}

@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects :(int)newFollowRedirects;

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 URLScheme is the same; otherwise, the class .

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

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

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

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

Idle Property (RSS Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

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.

IfModifiedSince Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var ifModifiedSince: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=ifModifiedSince,setter=setIfModifiedSince:) NSString* ifModifiedSince;

- (NSString*)ifModifiedSince;
- (void)setIfModifiedSince :(NSString*)newIfModifiedSince;

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

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

Items Property (RSS Module)

This property includes a collection of items in the current RSS feed.

Syntax

• Swift
• Objective-C

public var items: Array<RSSItem> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=itemCount,setter=setItemCount:) int itemCount;

- (int)itemCount;
- (void)setItemCount :(int)newItemCount;

- (NSString*)itemAuthor:(int)itemIndex;
- (void)setItemAuthor:(int)itemIndex :(NSString*)newItemAuthor;

- (NSString*)itemCategory:(int)itemIndex;
- (void)setItemCategory:(int)itemIndex :(NSString*)newItemCategory;

- (NSString*)itemCategoryDomain:(int)itemIndex;
- (void)setItemCategoryDomain:(int)itemIndex :(NSString*)newItemCategoryDomain;

- (NSString*)itemComments:(int)itemIndex;
- (void)setItemComments:(int)itemIndex :(NSString*)newItemComments;

- (NSString*)itemDescription:(int)itemIndex;
- (void)setItemDescription:(int)itemIndex :(NSString*)newItemDescription;

- (NSString*)itemEnclosureLength:(int)itemIndex;
- (void)setItemEnclosureLength:(int)itemIndex :(NSString*)newItemEnclosureLength;

- (NSString*)itemEnclosureType:(int)itemIndex;
- (void)setItemEnclosureType:(int)itemIndex :(NSString*)newItemEnclosureType;

- (NSString*)itemEnclosureUrl:(int)itemIndex;
- (void)setItemEnclosureUrl:(int)itemIndex :(NSString*)newItemEnclosureUrl;

- (NSString*)itemGuid:(int)itemIndex;
- (void)setItemGuid:(int)itemIndex :(NSString*)newItemGuid;

- (BOOL)itemGuidIsPermaLink:(int)itemIndex;
- (void)setItemGuidIsPermaLink:(int)itemIndex :(BOOL)newItemGuidIsPermaLink;

- (NSString*)itemXML:(int)itemIndex;
- (void)setItemXML:(int)itemIndex :(NSString*)newItemXML;

- (NSString*)itemLink:(int)itemIndex;
- (void)setItemLink:(int)itemIndex :(NSString*)newItemLink;

- (NSString*)itemPubDate:(int)itemIndex;
- (void)setItemPubDate:(int)itemIndex :(NSString*)newItemPubDate;

- (NSString*)itemSource:(int)itemIndex;
- (void)setItemSource:(int)itemIndex :(NSString*)newItemSource;

- (NSString*)itemSourceURL:(int)itemIndex;
- (void)setItemSourceURL:(int)itemIndex :(NSString*)newItemSourceURL;

- (NSString*)itemTitle:(int)itemIndex;
- (void)setItemTitle:(int)itemIndex :(NSString*)newItemTitle;

Default Value

""

Remarks

This property contains a collection of items in the current RSS channel. When an RSS feed is parsed by the component, all of the items in the feed are stored as RSSItem types in this collection.

This collection can also be populated before writing an RSS feed with WriteFile.

LocalFile Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

Default Value

""

Remarks

This property is used when getting a document.

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

LocalHost Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

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

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

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

Namespaces Property (RSS Module)

This property includes a collection of namespaces in the current namespace stack.

Syntax

• Swift
• Objective-C

public var namespaces: Array<XMLNamespace> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount;

- (int)namespaceCount;
- (void)setNamespaceCount :(int)newNamespaceCount;

- (NSString*)namespacePrefix:(int)namespaceIndex;
- (void)setNamespacePrefix:(int)namespaceIndex :(NSString*)newNamespacePrefix;

- (NSString*)namespaceURI:(int)namespaceIndex;
- (void)setNamespaceURI:(int)namespaceIndex :(NSString*)newNamespaceURI;

Default Value

""

Remarks

This property contains a list of the XML namespaces that exist in the current RSS channel. Each version of the RSS protocol defines a specific set of standard RSS feed properties. The general RSS protocol, however, allows nonstandard fields to be added through XML namespaces.

When parsing an RSS feed retrieved through the GetFeed method, the class will store all properties that are standard in version 2.0 of the RSS protocol, regardless of the version given by the feed. For nonstandard properties, it will verify that the property has a namespace and that the namespace is defined within the RSS feed. If a property's definition cannot be found, the class . Nonstandard fields can be retrieved through the GetProperty method.

When using the WriteFile method to generate an RSS feed that contains nonstandard properties, you must use the SetProperty method to set each nonstandard property. The class will ignore any property whose namespace is not defined when generating the RSSData.

Please see the GetProperty and SetProperty methods for details on argument syntax.

OtherHeaders Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

Default Value

""

Remarks

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

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

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.

ParsedHeaders Property (RSS Module)

This property includes a collection of headers returned from the last request.

Syntax

• Swift
• Objective-C

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

Default Value

""

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

Password Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

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

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

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

Proxy Property (RSS Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Referer Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var referer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=referer,setter=setReferer:) NSString* referer;

- (NSString*)referer;
- (void)setReferer :(NSString*)newReferer;

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.

RSSData Property (RSS Module)

This property includes the complete text of the RSS XML file.

Syntax

• Swift
• Objective-C

public var rssData: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=RSSData,setter=setRSSData:) NSString* RSSData;

- (NSString*)RSSData;
- (void)setRSSData :(NSString*)newRSSData;

Default Value

""

Remarks

When retrieving RSS feeds through the GetFeed or HTML through the GetURL method, this property will contain the complete original text of the feed. When writing an RSS feed using the WriteFile method, the class RSSData will be generated from the existing properties.

RSSVersion Property (RSS Module)

This property includes the RSS protocol version of the current RSS feed.

Syntax

• Swift
• Objective-C

public var rssVersion: RssRSSVersions {
  get {...}
  set {...}
}

public enum RssRSSVersions: Int32 {
  case rssVersionUndefined = 0
  case rssVersion091 = 1
  case rssVersion092 = 2
  case rssVersion200 = 3
}

@property (nonatomic,readwrite,assign,getter=RSSVersion,setter=setRSSVersion:) int RSSVersion;

- (int)RSSVersion;
- (void)setRSSVersion :(int)newRSSVersion;

Default Value

3

Remarks

This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the class will check this value and throw an error for missing required properties.

The following values are currently recognized by the class:

To set properties not defined in the given version, use the Namespaces properties, to list and define namespaces and the GetProperty and SetProperty methods, and to list and define each nonstandard property.

SSLAcceptServerCertEncoded Property (RSS Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (RSS Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (RSS Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: RssSSLCertStoreTypes {
  get {...}
  set {...}
}

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

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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:

SSLCertSubject Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (RSS Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: RssSSLProviders {
  get {...}
  set {...}
}

public enum RssSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (RSS Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (RSS Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

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.

TransferredData Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var transferredData: String {
  get {...}
}

public var transferredDataB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transferredData) NSString* transferredData;

- (NSString*)transferredData;

@property (nonatomic,readonly,assign,getter=transferredDataB) NSData* transferredDataB;

- (NSData*)transferredDataB;

Default Value

""

Remarks

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

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

This property is read-only.

TransferredDataLimit Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var transferredDataLimit: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transferredDataLimit,setter=setTransferredDataLimit:) long long transferredDataLimit;

- (long long)transferredDataLimit;
- (void)setTransferredDataLimit :(long long)newTransferredDataLimit;

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.

TransferredHeaders Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var transferredHeaders: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transferredHeaders) NSString* transferredHeaders;

- (NSString*)transferredHeaders;

Default Value

""

Remarks

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

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

This property is read-only.

User Property (RSS Module)

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

Syntax

• Swift
• Objective-C

public var user: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

Default Value

""

Remarks

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

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

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

AddCookie Method (RSS Module)

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

Syntax

• Swift
• Objective-C

public func addCookie(cookieName: String, cookieValue: String) throws -> Void

- (void)addCookie:(NSString*)cookieName :(NSString*)cookieValue;

Remarks

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

AddItem Method (RSS Module)

This method inserts a new item into the beginning of an RSS feed.

Syntax

• Swift
• Objective-C

public func addItem(title: String, description_: String, link: String) throws -> Void

- (void)addItem:(NSString*)title :(NSString*)description :(NSString*)link;

Remarks

This method assumes that the items are new and more important than existing items and thus adds the item to the beginning of the current item list. This method requires the three standard fields Title, Description, and Link to be specified.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 2. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

AddNamespace Method (RSS Module)

This method adds a namespace to the Namespaces properties.

Syntax

• Swift
• Objective-C

public func addNamespace(prefix: String, namespaceURI: String) throws -> Void

- (void)addNamespace:(NSString*)prefix :(NSString*)namespaceURI;

Remarks

This method adds a namespace to the Namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Config Method (RSS Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

DoEvents Method (RSS Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

GetFeed Method (RSS Module)

This method fetches an RSS feed.

Syntax

• Swift
• Objective-C

public func getFeed(url: String) throws -> Void

- (void)getFeed:(NSString*)URL;

Remarks

This method fetches documents using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers through the Header event. If the LocalFile property has been set, the class will write the transferred data there.

The class will then attempt to parse the RSS feed, filling in the channel and item properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

GetProperty Method (RSS Module)

This method gets the value of a specific RSS feed item element or attribute.

Syntax

• Swift
• Objective-C

public func getProperty(propertyName: String) throws -> String

- (NSString*)getProperty:(NSString*)propertyName;

Remarks

This method is intended to extend the functionality of the RSS class. It will get the value for a specific item element or attribute of this RSS feed. Property is the XPath of the element or attribute according to the following convention: root/element@attribute. The @attribute part is optional, and the root field can be any of the four 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, this method will return the text portion of element.

Example. GetProperty:

RSSControl.GetProperty("item[5]/guid@isPermaLink") RSSControl.GetProperty("item[5]/link") RSSControl.GetProperty("/channel/title")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS 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.

GetURL Method (RSS Module)

This method fetches an RSS feed.

Syntax

• Swift
• Objective-C

public func getURL(url: String) throws -> Void

- (void)getURL:(NSString*)URL;

Remarks

This method fetches the document using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers are delivered through the Header event. If the LocalFile property has been set, the class will write the transferred data there.

The class will not parse the data returned by the server. For more control over the retrieval of the item link, please use the HTTP class.

Interrupt Method (RSS Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

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

OPMLAttr Method (RSS Module)

This method returns the value of the attribute specified in the parameter.

Syntax

• Swift
• Objective-C

public func OPMLAttr(attrName: String) throws -> String

- (NSString*)OPMLAttr:(NSString*)attrName;

Remarks

This method may be used to get the value of an attribute for an outline entry of an OPML document. The desired attribute must be specified in the parameter of this method. This method also must be invoked inside the OPMLOutline event.

Put Method (RSS Module)

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

Syntax

• Swift
• Objective-C

public func put(url: String) throws -> Void

- (void)put:(NSString*)URL;

Remarks

This method sends data to the HTTP server. The data are taken from PostData or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to User and Password or Authorization.

ReadFile Method (RSS Module)

This method loads an RSS file into the component.

Syntax

• Swift
• Objective-C

public func readFile(fileName: String) throws -> Void

- (void)readFile:(NSString*)fileName;

Remarks

This method loads an RSS file and attempts to parse it, filling in the properties as it goes. The feed properties can be accessed either directly through the named properties or through the GetProperty and SetProperty methods.

ReadOPML Method (RSS Module)

This method reads and parses an OPML file.

Syntax

• Swift
• Objective-C

public func readOPML(opmlFile: String) throws -> Void

- (void)readOPML:(NSString*)OPMLFile;

Remarks

This method reads in the OPML file specified by OPMLFile. The class then parses the file and returns the data to the user in the OPMLHeader and OPMLOutline events.

Reset Method (RSS Module)

This method resets all properties of the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

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 RSS feed.

SetProperty Method (RSS Module)

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

Syntax

• Swift
• Objective-C

public func setProperty(propertyName: String, propertyValue: String) throws -> Void

- (void)setProperty:(NSString*)propertyName :(NSString*)propertyValue;

Remarks

This method is intended to extend the functionality of the RSS class. It will set the value for a specific field of this RSS feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be any of the four 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. Example. SetProperty:

RSSControl.SetProperty("item[5]/guid@isPermaLink", "true")

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

WriteFile Method (RSS Module)

This method writes an RSS feed from the component.

Syntax

• Swift
• Objective-C

public func writeFile(filename: String) throws -> Void

- (void)writeFile:(NSString*)filename;

Remarks

This method will write an RSS feed from the existing property values to Filename. The RSS feed will be preverified, and if there are any missing required fields, the class .

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 3. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

Connected Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

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

Disconnected Event (RSS Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (RSS Module)

This event is fired when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)direction;

Remarks

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

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

Error Event (RSS Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

Header Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)value;

Remarks

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

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

Log Event (RSS Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

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"

OPMLHeader Event (RSS Module)

This event is fired for each value in the header section of the current OPML document.

Syntax

• Swift
• Objective-C

func onOPMLHeader(field: String, value: String)

- (void)onOPMLHeader:(NSString*)field :(NSString*)value;

Remarks

This event is fired when the class is parsing an OPML document after a call to ReadOPML is made. The class parses each header field and value from the OPML document and fires OPMLHeader once for each header present.

OPMLOutline Event (RSS Module)

This event is fired for each outline in the current OPML document.

Syntax

• Swift
• Objective-C

func onOPMLOutline(level: Int32, text: String, typeName: String, title: String, url: String, xmlurl: String, htmlurl: String, created: String, description: String, otherAttrs: String)

- (void)onOPMLOutline:(int)level :(NSString*)text :(NSString*)typeName :(NSString*)title :(NSString*)URL :(NSString*)XMLURL :(NSString*)HTMLURL :(NSString*)created :(NSString*)description :(NSString*)otherAttrs;

Remarks

This event is fired for each outline in the OPML document.

The Level parameter contains the depth of the current outline in the OPML document.

Each outline contains a Text attribute, which is parsed out, and returned in the Text parameter.

The Type attribute is a string that describes how the other attributes of the outline are interpreted and is returned in the TypeName parameter.

The Title parameter refers to the title of the outline.

The URL parameter indicates the external location of the outline.

The XMLURL parameter is usually set to an RSS, Atom, or OPML file.

The HTMLURL parameter specifies an HTMLURL attribute, which may be used instead of the URL attribute.

The Created parameter contains the date the outline node was created.

The OtherAttrs parameter contains a list of other attributes for the current outline. In this case, you must use the OPMLAttr method to get the attribute's corresponding values from the parser.

Redirect Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onRedirect(location: String, accept: inout Bool)

- (void)onRedirect:(NSString*)location :(int*)accept;

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 . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onSetCookie(name: String, value: String, expires: String, domain: String, path: String, secure: Bool)

- (void)onSetCookie:(NSString*)name :(NSString*)value :(NSString*)expires :(NSString*)domain :(NSString*)path :(BOOL)secure;

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (RSS Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

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

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

SSLStatus Event (RSS Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

StartTransfer Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)direction;

Remarks

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

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

Status Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onStatus(httpVersion: String, statusCode: Int32, description: String)

- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)description;

Remarks

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

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

Transfer Event (RSS Module)

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

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;

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.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public init()

public init(field: , value: )

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public init()

public init(name: , value: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

RSSChannel Type

This is the information about an RSS feed as received from the server.

Remarks

When an RSS feed is parsed by the component, each item is parsed into an rssitem type and other information about the feed is presented as RSSChannel.

Fields

Constructors

public init()

public init(title: , description: )

RSSItem Type

This is an RSS item as it is received from the RSS feed.

Remarks

When an RSS feed is parsed by the component, each item is parsed into an RSSItem type. This type contains field value pairs for standard RSS 2.0 elements.

Fields

Constructors

public init()

public init(title: , description: )

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the and the of the namespace being defined.

The default namespace exists at index 0. The field at index 0 is "xmlns", and the field contains the default namespace.

Fields

Constructors

public init()

public init(name: , prefix: )

Config Settings (RSS Module)

RSS 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

Trappable Errors (RSS Module)

RSS Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors