CkoRest Objective-C Reference Documentation

CkoRest

Current Version: 9.5.0.73

API for implementing RESTful Web API's.

Object Creation

CkoRest *obj = [[CkoRest alloc] init];

Properties

AllowHeaderFolding
@property (nonatomic) BOOL AllowHeaderFolding;
Introduced in version 9.5.0.63

If this property is set to NO, then no MIME header folding will be automatically applied to any request header. The default is YES. This property is provided to satisfy certain providers, such as Quickbooks, that require all MIME headers to be single unfolded lines regardless of length.

top
AllowHeaderQB
@property (nonatomic) BOOL AllowHeaderQB;
Introduced in version 9.5.0.59

Controls whether non us-ascii HTTP request headers are automatically Q/B encoded. The default value is YES.

Q/B encoded headers explicitly indicate the charset and byte representation, and appear as such: =?utf-8?Q?...?= or =?utf-8?B?...?=, where the charset may be "utf-8" or any other possible charset.

If this property is set to NO, then no Q/B encoding is applied to any request header.

top
Authorization
@property (nonatomic, copy) NSString *Authorization;
Introduced in version 9.5.0.58

The value of the Authorization HTTP request header (if needed).

top
ConnectFailReason
@property (nonatomic, readonly, copy) NSNumber *ConnectFailReason;
Introduced in version 9.5.0.58

If the Connect method fails, this property can be checked to determine the reason for failure.

Possible values are:

0 = success

Normal (non-SSL) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.

top
ConnectTimeoutMs
@property (nonatomic, copy) NSNumber *ConnectTimeoutMs;
Introduced in version 9.5.0.71

The maximum amount of time to wait for the connection to be accepted by the HTTP server.

Note: Suprisingly, this property was forgotten and not added until Chilkat v9.5.0.71.

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
HeartbeatMs
@property (nonatomic, copy) NSNumber *HeartbeatMs;
Introduced in version 9.5.0.58

This property is only valid in programming environment and languages that allow for event callbacks.

Specifies the time interval in milliseconds between AbortCheck events. A value of 0 (the default) indicate that no AbortCheck events will fire. Any REST method can be aborted via the AbortCheck event.

top
Host
@property (nonatomic, copy) NSString *Host;
Introduced in version 9.5.0.58

The value of the Host HTTP request header.

top
IdleTimeoutMs
@property (nonatomic, copy) NSNumber *IdleTimeoutMs;
Introduced in version 9.5.0.58

The maximum amount of time to wait for additional incoming data when receiving, or the max time to wait to send additional data. The default value is 30000 (30 seconds). This is not an overall max timeout. Rather, it is the maximum time to wait when receiving or sending has halted.

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastRequestHeader
@property (nonatomic, readonly, copy) NSString *LastRequestHeader;
Introduced in version 9.5.0.58

The full MIME header (not including the HTTP start line which contains the status code and status text), of the last request sent.

top
LastRequestStartLine
@property (nonatomic, readonly, copy) NSString *LastRequestStartLine;
Introduced in version 9.5.0.58

The full start line of the last request sent. (The start line begins with the HTTP verb, such as GET, POST, etc., is followed by the URI path, and ends with the HTTP version.)

top
NumResponseHeaders
@property (nonatomic, readonly, copy) NSNumber *NumResponseHeaders;
Introduced in version 9.5.0.58

The number of response header fields. The first response header field is at index 0.

top
PartSelector
@property (nonatomic, copy) NSString *PartSelector;
Introduced in version 9.5.0.58

Only used for multipart requests. Selects the target MIME part for calls to AddHeader, RemoveHeader, SetMultipartBodyBinary, SetMultipartBodyString, SetMultipartBodyStream, etc. The default is an empty string and indicates the top-level header. A string value of "1" would indicate the 1st sub-part in a multipart request. A string value of "1.2" would indicate the 2nd sub-part under the 1st sub-part.

It is unlikely you'll ever encounter the need for nested multipart requests (i.e. part selectors such as "1.2") Also, most REST requests are NOT multipart, and therefore this feature is rarely used. An example of a multipart REST request would be for a Google Drive upload, where the top-level Content-Type is multipart/related, the1st sub-part contains the JSON meta-data, and the 2nd sub-part contains the file data.

top
PercentDoneOnSend
@property (nonatomic) BOOL PercentDoneOnSend;
Introduced in version 9.5.0.58

This property only applies to the FullRequest* methods, which are methods that both send an HTTP request and receive the response. (It also only applies to programming languages that support event callbacks.) It determines whether percentage completion is tracked for the sending of the HTTP request, or for the downloading the HTTP response. The default value is NO, which is to measure the percent completion when receiving the response.

For example: If the REST request is to download a file, then this property should remain at the default value of NO. If the REST request is to upload a file (using a Full* method), then set this property to YES. Also note if a server sends an HTTP response in the chunked encoding, it is not possible to measure percent completion because the HTTP client has no way of knowing the total size of the HTTP response.

top
ResponseHeader
@property (nonatomic, readonly, copy) NSString *ResponseHeader;
Introduced in version 9.5.0.58

The full response MIME header (not including the HTTP start line which contains the status code and status text).

top
ResponseStatusCode
@property (nonatomic, readonly, copy) NSNumber *ResponseStatusCode;
Introduced in version 9.5.0.58

The response status code.

top
ResponseStatusText
@property (nonatomic, readonly, copy) NSString *ResponseStatusText;
Introduced in version 9.5.0.58

The status message corresponding to the response status code.

top
StreamNonChunked
@property (nonatomic) BOOL StreamNonChunked;
Introduced in version 9.5.0.58

If YES, then methods that upload data are sent non-chunked if possible. For example, if the FullRequestStream method is called where the stream is a file stream, then the size of the content is known and the HTTP request will be sent using a Content-Length header instead of using a Transfer-Encoding: chunked upload. If NO, then the chunked transfer encoding is used. The default value of this property is YES.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "9.5.0.63"

top

Methods

AddHeader
- (BOOL)AddHeader:(NSString *)name
    value:(NSString *)value;
Introduced in version 9.5.0.58

Adds an HTTP request header. If the header field already exists, then it is replaced.

Returns YES for success, NO for failure.

top
AddMwsSignature
- (BOOL)AddMwsSignature:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    domain:(NSString *)domain
    mwsSecretKey:(NSString *)mwsSecretKey;
Introduced in version 9.5.0.66

Computes the Amazon MWS signature using the mwsSecretKey and adds the "Signature" parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added.

The domain should be the domain of the request, such as one of the following:

  • mws.amazonservices.com
  • mws-eu.amazonservices.com
  • mws.amazonservices.in
  • mws.amazonservices.com.cn
  • mws.amazonservices.jp

The httpVerb should be the HTTP verb, such as "GET", "POST", etc. The uriPath is the URI path, such as "/Feeds/2009-01-01". In general, the httpVerb and uriPath should be identical to the 1st two args passed to methods such as FullRequestFormUrlEncoded.

Note: This method also automatically adds or replaces the existing Timestamp parameter to the current system date/time.

Returns YES for success, NO for failure.

top
AddPathParam
- (BOOL)AddPathParam:(NSString *)name
    value:(NSString *)value;
Introduced in version 9.5.0.70

Adds or replaces a path parameter. A path parameter is a string that will be replaced in any uriPath string passed to a method. For example, if name is "fileId" and value is "1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl", then a uriPath argument of "/drive/v3/files/fileId" will be transformed to "/drive/v3/files/1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl" in a method call.

Returns YES for success, NO for failure.

top
AddQueryParam
- (BOOL)AddQueryParam:(NSString *)name
    value:(NSString *)value;
Introduced in version 9.5.0.58

Adds a query parameter. If the query parameter already exists, then it is replaced.

Returns YES for success, NO for failure.

top
AddQueryParams
- (BOOL)AddQueryParams:(NSString *)queryString;
Introduced in version 9.5.0.58

Adds the query parameters from the queryString. The queryString is a query string of the format field1=value1&field2=value2&field3=value3... where each value is URL encoded.

Returns YES for success, NO for failure.

top
AddQueryParamSb
- (BOOL)AddQueryParamSb:(NSString *)name
    value:(CkoStringBuilder *)value;
Introduced in version 9.5.0.62

Adds a query parameter. If the query parameter already exists, then it is replaced. The parameter value is passed in a StringBuilder object.

Returns YES for success, NO for failure.

top
ClearAllHeaders
- (BOOL)ClearAllHeaders;
Introduced in version 9.5.0.58

Removes all HTTP request headers.

Returns YES for success, NO for failure.

top
ClearAllParts
- (BOOL)ClearAllParts;
Introduced in version 9.5.0.64

Removes all sub-parts from a request. This is useful when preparing the REST object to send a new request after a multipart request has just been sent.

Returns YES for success, NO for failure.

More Information and Examples
top
ClearAllPathParams
- (BOOL)ClearAllPathParams;
Introduced in version 9.5.0.70

Clears all path parameters.

Returns YES for success, NO for failure.

top
ClearAllQueryParams
- (BOOL)ClearAllQueryParams;
Introduced in version 9.5.0.58

Clears all query parameters.

Returns YES for success, NO for failure.

top
ClearAuth
- (BOOL)ClearAuth;
Introduced in version 9.5.0.69

Clears all authentication settings.

Returns YES for success, NO for failure.

top
ClearResponseBodyStream
- (void)ClearResponseBodyStream;
Introduced in version 9.5.0.58

Clears the response body stream set by calling SetResponseBodyStream.

top
Connect
- (BOOL)Connect:(NSString *)hostname
    port:(NSNumber *)port
    tls:(BOOL)tls
    autoReconnect:(BOOL)autoReconnect;
Introduced in version 9.5.0.58

Establishes an initial connection to a REST server. The hostname can be a domain name or an IP address. Both IPv4 and IPv6 addresses are supported. The port is the port, which is typically 80 or 443. If SSL/TLS is required, then tls should be set to YES. The autoReconnect indicates whether connection should automatically be established as needed for subsequent REST requests.

Note: This method is for simple connections that do not require any proxies (HTTP or SOCKS), or SSH tunneling. If a proxy, SSH tunnel, or any other advanced socket feature is required, the Chilkat Socket API can be used to establish the connection. The UseConnection method can then be called to use the pre-established socket connection.

Returns YES for success, NO for failure.

top
ConnectAsync (1)
- (CkoTask *)ConnectAsync:(NSString *)hostname
    port:(NSNumber *)port
    tls:(BOOL)tls
    autoReconnect:(BOOL)autoReconnect;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
Disconnect
- (BOOL)Disconnect:(NSNumber *)maxWaitMs;
Introduced in version 9.5.0.58

Closes the connection with the HTTP server if one is open. This method can be called to ensure the connection is closed. The maxWaitMs is the maximum time in milliseconds to wait for a clean close. If the connection is through an SSH tunnel, this closes the logical channel within the SSH tunnel, and not the connection with the SSH server itself.

Returns YES for success, NO for failure.

top
DisconnectAsync (1)
- (CkoTask *)DisconnectAsync:(NSNumber *)maxWaitMs;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the Disconnect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestBd
- (BOOL)FullRequestBd:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    binData:(CkoBinData *)binData
    responseBody:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.64

Sends a complete REST request (header + binary body) and receives the full response. The binary body of the request is passed in binData. The response body is returned in responseBody (replacing whatever contents responseBody may have previously held).

Returns YES for success, NO for failure.

More Information and Examples
top
FullRequestBdAsync (1)
- (CkoTask *)FullRequestBdAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    binData:(CkoBinData *)binData
    responseBody:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestBinary
- (NSString *)FullRequestBinary:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyBytes:(NSData *)bodyBytes;
Introduced in version 9.5.0.58

Sends a complete REST request (header + body) and receives the full response. It is assumed that the request body is binary, and the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqBinaryBody, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

More Information and Examples
top
FullRequestBinaryAsync (1)
- (CkoTask *)FullRequestBinaryAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyBytes:(NSData *)bodyBytes;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestFormUrlEncoded
- (NSString *)FullRequestFormUrlEncoded:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends a complete application/x-www-form-urlencoded HTTP request and receives the full response. The request body is composed of the URL encoded query params. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqFormUrlEncoded, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

top
FullRequestFormUrlEncodedAsync (1)
- (CkoTask *)FullRequestFormUrlEncodedAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestFormUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestMultipart
- (NSString *)FullRequestMultipart:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends a complete multipart REST request (header + multipart body) and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqMultipart, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

top
FullRequestMultipartAsync (1)
- (CkoTask *)FullRequestMultipartAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestMultipart method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestNoBody
- (NSString *)FullRequestNoBody:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends a complete REST request and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqNoBody, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

More Information and Examples
top
FullRequestNoBodyAsync (1)
- (CkoTask *)FullRequestNoBodyAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestNoBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestNoBodyBd
- (BOOL)FullRequestNoBodyBd:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    binData:(CkoBinData *)binData;
Introduced in version 9.5.0.64

The same as FullRequestNoBody, except returns the response body in the binData. This method is useful for downloading binary files.

Returns YES for success, NO for failure.

More Information and Examples
top
FullRequestNoBodyBdAsync (1)
- (CkoTask *)FullRequestNoBodyBdAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    binData:(CkoBinData *)binData;
Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestNoBodyBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestNoBodySb
- (BOOL)FullRequestNoBodySb:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    sb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.64

The same as FullRequestNoBody, except returns the response body in the sb.

Returns YES for success, NO for failure.

More Information and Examples
top
FullRequestNoBodySbAsync (1)
- (CkoTask *)FullRequestNoBodySbAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    sb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestNoBodySb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestSb
- (BOOL)FullRequestSb:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    requestBody:(CkoStringBuilder *)requestBody
    responseBody:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.62

Sends a complete REST request (header + body string) and receives the full response. The body of the request is passed in requestBody. The response body is returned in responseBody (replacing whatever contents responseBody may have previously held).

Returns YES for success, NO for failure.

top
FullRequestSbAsync (1)
- (CkoTask *)FullRequestSbAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    requestBody:(CkoStringBuilder *)requestBody
    responseBody:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.62

Creates an asynchronous task to call the FullRequestSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestStream
- (NSString *)FullRequestStream:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    stream:(CkoStream *)stream;
Introduced in version 9.5.0.58

Sends a complete REST request and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqStream, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

top
FullRequestStreamAsync (1)
- (CkoTask *)FullRequestStreamAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    stream:(CkoStream *)stream;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
FullRequestString
- (NSString *)FullRequestString:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyText:(NSString *)bodyText;
Introduced in version 9.5.0.58

Sends a complete REST request (header + body string) and receives the full response. It is assumed that both the request and response bodies are strings (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqStringBody, ReadResponseHeader, ReadRespBodyString.

Returns nil on failure

top
FullRequestStringAsync (1)
- (CkoTask *)FullRequestStringAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyText:(NSString *)bodyText;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadRespBd
- (BOOL)ReadRespBd:(CkoBinData *)responseBody;
Introduced in version 9.5.0.62

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body is binary, such as for JPG images or other non-text binary file types. The response body is received into responseBody (replacing whatever contents responseBody may have previously held).

Returns YES for success, NO for failure.

top
ReadRespBdAsync (1)
- (CkoTask *)ReadRespBdAsync:(CkoBinData *)responseBody;
Introduced in version 9.5.0.62

Creates an asynchronous task to call the ReadRespBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadRespBodyBinary
- (NSData *)ReadRespBodyBinary;
Introduced in version 9.5.0.58

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body is binary, such as for JPG images or other non-text binary file types.

Returns nil on failure

More Information and Examples
top
ReadRespBodyBinaryAsync (1)
- (CkoTask *)ReadRespBodyBinaryAsync;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadRespBodyStream
- (BOOL)ReadRespBodyStream:(CkoStream *)stream
    autoSetStreamCharset:(BOOL)autoSetStreamCharset;
Introduced in version 9.5.0.58

Reads the response body to the stream. If autoSetStreamCharset is YES, then the stream's StringCharset property will automatically get set based on the charset, if any, indicated in the response header. If the response is binary, then autoSetStreamCharset is ignored.

Returns YES for success, NO for failure.

top
ReadRespBodyStreamAsync (1)
- (CkoTask *)ReadRespBodyStreamAsync:(CkoStream *)stream
    autoSetStreamCharset:(BOOL)autoSetStreamCharset;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadRespBodyString
- (NSString *)ReadRespBodyString;
Introduced in version 9.5.0.58

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body will be a string (such as XML, JSON, etc.)

Returns nil on failure

More Information and Examples
top
ReadRespBodyStringAsync (1)
- (CkoTask *)ReadRespBodyStringAsync;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadResponseHeader
- (NSNumber *)ReadResponseHeader;
Introduced in version 9.5.0.58

Reads the HTTP response header. If the HTTP response includes a body, then the application must call the desired method to read the response body. Otherwise, the HTTP request / response is finished after reading the response header (such as for a GET request). The contents of the response header are available in various properties and methods.

The HTTP response status code is returned (such as 200 for a typical success response). If an error occurred such that no response was received, then a value of -1 is returned.

More Information and Examples
top
ReadResponseHeaderAsync (1)
- (CkoTask *)ReadResponseHeaderAsync;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadResponseHeader method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
ReadRespSb
- (BOOL)ReadRespSb:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.62

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body will be a string (such as XML, JSON, etc.) The response body is stored in responseBody. (replacing whatever contents responseBody may have previously held).

Returns YES for success, NO for failure.

top
ReadRespSbAsync (1)
- (CkoTask *)ReadRespSbAsync:(CkoStringBuilder *)responseBody;
Introduced in version 9.5.0.62

Creates an asynchronous task to call the ReadRespSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
RedirectUrl
- (CkoUrl *)RedirectUrl;
Introduced in version 9.5.0.58

If the response was a redirect and contains a Location header field, this method returns the redirect URL.

Returns nil on failure

top
RemoveHeader
- (BOOL)RemoveHeader:(NSString *)name;
Introduced in version 9.5.0.58

Removes all headers having the given name.

Returns YES for success, NO for failure.

top
RemoveQueryParam
- (BOOL)RemoveQueryParam:(NSString *)name;
Introduced in version 9.5.0.58

Removes all query params having the given name.

Returns YES for success, NO for failure.

top
ResponseHdrByName
- (NSString *)ResponseHdrByName:(NSString *)name;
Introduced in version 9.5.0.58

Returns the value of the response header indicated by name.

Returns nil on failure

top
ResponseHdrName
- (NSString *)ResponseHdrName:(NSNumber *)index;
Introduced in version 9.5.0.58

Returns the name of the Nth response header field. (Chilkat always uses 0-based indexing. The first header field is at index 0.)

Returns nil on failure

More Information and Examples
top
ResponseHdrValue
- (NSString *)ResponseHdrValue:(NSNumber *)index;
Introduced in version 9.5.0.58

Returns the value of the Nth response header field. (Chilkat always uses 0-based indexing. The first header field is at index 0.)

Returns nil on failure

More Information and Examples
top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

top
SendReqBd
- (BOOL)SendReqBd:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    body:(CkoBinData *)body;
Introduced in version 9.5.0.62

Sends a REST request that cotnains a binary body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The body contains the bytes of the HTTP request body.

Returns YES for success, NO for failure.

top
SendReqBdAsync (1)
- (CkoTask *)SendReqBdAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    body:(CkoBinData *)body;
Introduced in version 9.5.0.62

Creates an asynchronous task to call the SendReqBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqBinaryBody
- (BOOL)SendReqBinaryBody:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    body:(NSData *)body;
Introduced in version 9.5.0.58

Sends a REST request that cotnains a binary body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The body contains the bytes of the HTTP request body.

Returns YES for success, NO for failure.

top
SendReqBinaryBodyAsync (1)
- (CkoTask *)SendReqBinaryBodyAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    body:(NSData *)body;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqBinaryBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqFormUrlEncoded
- (BOOL)SendReqFormUrlEncoded:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends an application/x-www-form-urlencoded HTTP request where the body is composed of the URL encoded query params. The httpVerb is the HTTP verb (also known as the HTTP method), such as "POST". The uriPath is the path of the resource URI. If the Content-Type header was set, it is ignored and instead the Content-Type of the request will be "application/x-www-form-urlencoded".

Returns YES for success, NO for failure.

top
SendReqFormUrlEncodedAsync (1)
- (CkoTask *)SendReqFormUrlEncodedAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqFormUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqMultipart
- (BOOL)SendReqMultipart:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends a multipart REST request. The httpVerb is the HTTP verb (also known as the HTTP method), such as "GET". The uriPath is the path of the resource URI.

Returns YES for success, NO for failure.

top
SendReqMultipartAsync (1)
- (CkoTask *)SendReqMultipartAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqMultipart method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqNoBody
- (BOOL)SendReqNoBody:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Sends a REST request that cotnains no body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "GET". The uriPath is the path of the resource URI.

Returns YES for success, NO for failure.

top
SendReqNoBodyAsync (1)
- (CkoTask *)SendReqNoBodyAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqNoBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqSb
- (BOOL)SendReqSb:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodySb:(CkoStringBuilder *)bodySb;
Introduced in version 9.5.0.62

Sends a REST request that cotnains a text body, such as XML or JSON. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The bodySb contains the text of the HTTP request body.

Returns YES for success, NO for failure.

top
SendReqSbAsync (1)
- (CkoTask *)SendReqSbAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodySb:(CkoStringBuilder *)bodySb;
Introduced in version 9.5.0.62

Creates an asynchronous task to call the SendReqSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqStreamBody
- (BOOL)SendReqStreamBody:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    stream:(CkoStream *)stream;
Introduced in version 9.5.0.58

Sends a REST request that cotnains a binary or text body that is obtained by reading from the stream. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI.

Returns YES for success, NO for failure.

More Information and Examples
top
SendReqStreamBodyAsync (1)
- (CkoTask *)SendReqStreamBodyAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    stream:(CkoStream *)stream;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqStreamBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SendReqStringBody
- (BOOL)SendReqStringBody:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyText:(NSString *)bodyText;
Introduced in version 9.5.0.58

Sends a REST request that cotnains a text body, such as XML or JSON. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The bodyText contains the text of the HTTP request body.

Returns YES for success, NO for failure.

More Information and Examples
top
SendReqStringBodyAsync (1)
- (CkoTask *)SendReqStringBodyAsync:(NSString *)httpVerb
    uriPath:(NSString *)uriPath
    bodyText:(NSString *)bodyText;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqStringBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SetAuthAws
- (BOOL)SetAuthAws:(CkoAuthAws *)authProvider;
Introduced in version 9.5.0.58

Sets the authorization service provider for Amazon AWS REST requests. An application that sets an AWS authentication provider need not explicitly set the Authorization property. Each REST request is automatically signed and authenticated using the authProvider.

Returns YES for success, NO for failure.

More Information and Examples
top
SetAuthAzureAD
- (BOOL)SetAuthAzureAD:(CkoAuthAzureAD *)authProvider;
Introduced in version 9.5.0.58

Sets the Azure AD (Active Directory) authorization service provider.

Returns YES for success, NO for failure.

top
SetAuthAzureSas
- (BOOL)SetAuthAzureSas:(CkoAuthAzureSAS *)authProvider;
Introduced in version 9.5.0.65

Provides the information for Azure SAS (Shared Access Signature) authorization. Calling this method will cause the "Authorization: SharedAccessSignature ..." header to be automatically added to all requests.

Returns YES for success, NO for failure.

More Information and Examples
top
SetAuthAzureStorage
- (BOOL)SetAuthAzureStorage:(CkoAuthAzureStorage *)authProvider;
Introduced in version 9.5.0.58

Sets the authorization service provider for Azure Storage Service requests.

Returns YES for success, NO for failure.

top
SetAuthBasic
- (BOOL)SetAuthBasic:(NSString *)username
    password:(NSString *)password;
Introduced in version 9.5.0.58

Sets the username and password to be used for Basic authentication. This method should be called when Basic authentication is required. It should only be used with secure SSL/TLS connections. Calling this method will cause the "Authorization: Basic ..." header to be automatically added to all requests. In many cases, a REST API will support Basic authentication where the username is a client ID or account ID, and the password is a client secret or token.

Returns YES for success, NO for failure.

More Information and Examples
top
SetAuthBasicSecure
- (BOOL)SetAuthBasicSecure:(CkoSecureString *)username
    password:(CkoSecureString *)password;
Introduced in version 9.5.0.71

The same as SetAuthBasic, but provides a more secure means for passing the arguments as secure string objects.

Returns YES for success, NO for failure.

More Information and Examples
top
SetAuthGoogle
- (BOOL)SetAuthGoogle:(CkoAuthGoogle *)authProvider;
Introduced in version 9.5.0.58

Sets the authorization service provider for Google API requests.

Returns YES for success, NO for failure.

top
SetAuthOAuth1
- (BOOL)SetAuthOAuth1:(CkoOAuth1 *)authProvider
    useQueryParams:(BOOL)useQueryParams;
Introduced in version 9.5.0.58

Sets the authentication provider for REST API requests needing OAuth 1.0 (and OAuth 1.0a) authentication. If useQueryParams is YES, then the OAuth1 authentication information and signature is passed in query parameters. Otherwise it is passed in an Authorization header.

Returns YES for success, NO for failure.

top
SetAuthOAuth2
- (BOOL)SetAuthOAuth2:(CkoOAuth2 *)authProvider;
Introduced in version 9.5.0.59

Sets the authentication provider for REST API requests needing standards-based OAuth 2.0 authentication. This is for the case where a desktop/native/mobile application will be popping up a web browser, or embedding a web browser, to get authorization interactively from end-user of the application.

Returns YES for success, NO for failure.

top
SetMultipartBodyBd
- (BOOL)SetMultipartBodyBd:(CkoBinData *)bodyData;
Introduced in version 9.5.0.62

Only used for multipart requests. Sets the binary content of the multipart body indicated by the PartSelector.

Returns YES for success, NO for failure.

More Information and Examples
top
SetMultipartBodyBinary
- (BOOL)SetMultipartBodyBinary:(NSData *)bodyData;
Introduced in version 9.5.0.58

Only used for multipart requests. Sets the binary content of the multipart body indicated by the PartSelector.

Returns YES for success, NO for failure.

top
SetMultipartBodySb
- (BOOL)SetMultipartBodySb:(CkoStringBuilder *)bodySb;
Introduced in version 9.5.0.62

Only used for multipart requests. Sets the text content of the multipart body indicated by the PartSelector.

Returns YES for success, NO for failure.

More Information and Examples
top
SetMultipartBodyStream
- (BOOL)SetMultipartBodyStream:(CkoStream *)stream;
Introduced in version 9.5.0.58

Only used for multipart requests. Sets the stream source of the multipart body indicated by the PartSelector.

Returns YES for success, NO for failure.

top
SetMultipartBodyString
- (BOOL)SetMultipartBodyString:(NSString *)bodyText;
Introduced in version 9.5.0.58

Only used for multipart requests. Sets the text content of the multipart body indicated by the PartSelector.

Returns YES for success, NO for failure.

top
SetResponseBodyStream
- (BOOL)SetResponseBodyStream:(NSNumber *)expectedStatus
    autoSetStreamCharset:(BOOL)autoSetStreamCharset
    responseStream:(CkoStream *)responseStream;
Introduced in version 9.5.0.58

Only applies to the Full* methods, such as FullRequestNoBody, FullRequestBinary, FullRequestStream, etc. When set, the response body is streamed directly to responseStream, if (and only if) the HTTP response status code equals expectedStatus.

If the response body was streamed to responseStream, then the string return value of the Full* method instead becomes "OK" for success. If an attempt was made to stream the response body but it failed, then "FAIL" is returned. If the response body was not streamed because the response status code was not equal to expectedStatus, then the returned string contains the server's error response.

If autoSetStreamCharset is YES, then the expectedStatus's StringCharset property will automatically get set based on the charset, if any, indicated in the response header. If the response is binary, then autoSetStreamCharset is ignored.

Starting in v9.5.0.75, the expectedStatus may be passed as a negative number to specify a range of expected (success) status codes. For example:

  • -200: Allow status codes 200 - 299
  • -210: Allow status codes 210 - 219
  • -220: Allow status codes 220 - 229
  • etc.

Returns YES for success, NO for failure.

More Information and Examples
top
UseConnection
- (BOOL)UseConnection:(CkoSocket *)connection
    autoReconnect:(BOOL)autoReconnect;
Introduced in version 9.5.0.58

Sets the connection to be used for sending the REST request. The connection should be an already-connected socket. It may be a TLS connection, an unencrypted connection, through an HTTP proxy, a SOCKS proxy, or even through SSH tunnels. All of the connection related functionality is handled by the Chilkat Socket API.

The autoReconnect indicates whether connection should automatically be established as needed for subsequent REST requests.

Important: The UseConnection method is provided as a means for handling more complicated connections -- such as connections through proxies, tunnels, etc. If your application is connecting directly to the HTTP server, then simply call this class's Connect method.

Returns YES for success, NO for failure.

top

Events

To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.

For example:

  CkoRest *rest = [[CkoRest alloc] init];

  MyRestProgress *callbackObj = [[MyRestProgress alloc] init];

  [rest setEventCallbackObject:callbackObj];

MyRestProgress interface example:

#import "CkoRestProgress.h"

@interface MyRestProgress : CkoBaseProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;

    - (void)BinaryData:(NSData *)data 
        length:(NSNumber *)length;

    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;

    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;

    - (void)TaskCompleted:(CkoTask *)task;

    - (void)TextData:(NSString *)data;

@end
AbortCheck
- (void)AbortCheck:(BOOL *)abort;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

top
PercentDone
- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to YES will cause the method to abort and return a failed status (or whatever return value indicates failure).

top
ProgressInfo
- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

top
TaskCompleted
- (void)TaskCompleted:(CkoTask *)task;

Called in the background thread when an asynchronous task completes.

top