Rest

Controls whether long request-header fields may be folded onto continuation lines. The default is False. When set to False, each request header is emitted on a single physical line.

Controls whether non-ASCII request-header values may be converted to RFC 2047 encoded-word form using Q or Base64 encoding. The default is True.

Encoded words have forms such as =?utf-8?Q?...?= and =?utf-8?B?...?=. When this property is False, Chilkat does not apply this conversion.

Gets or sets the value sent in the HTTP Authorization request header. Supply only the field value, such as Bearer eyJ..., not the text Authorization:.

After Connect fails, returns a code identifying the connection stage or TLS handshake stage that failed.

TLS-related codes:

Gets or sets the maximum number of milliseconds to wait for the remote server to accept the TCP connection. This timeout covers connection establishment, not the later sending or receiving of HTTP data.

The default is 30000 milliseconds.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

When True, calls to the Send* and FullRequest* methods compose the complete request but do not transmit it. Retrieve the generated request with GetLastDebugRequest. The default is False.

In debug mode, a composed full-request call reports a synthetic successful result with ResponseStatusCode equal to 201, ResponseStatusText equal to OK, and no actual response header or response body.

Controls automatic resolution of credentials from operating-system secure storage. The default is False.

When set to True, supported credential inputs may contain a secret specification beginning with !! instead of a literal secret. Chilkat resolves the specification from Windows Credential Manager on Windows or Apple Keychain on macOS.

The specification format is:

!![appName|]service[|domain]|username

For this class, secret specifications apply to the username and password supplied to SetAuthBasic.

Controls the interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations. The default is 0, which disables periodic AbortCheck callbacks.

Gets or sets the value of the HTTP Host request header.

An explicitly assigned value overrides the generated HTTP Host field, but it does not change the TCP/TLS destination established by Connect or UseConnection.

Gets or sets the maximum number of milliseconds to wait when a send or receive operation has stopped making progress. The default is 30000 milliseconds.

A value of 0 disables the inactivity timeout.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Returns the redirect target from the most recently received response. The value comes from the response Location header. If the most recent response was not a redirect or did not contain a Location header, this property is empty.

Returns the HTTP header fields from the most recently composed request, excluding the request line. The request line is available separately in LastRequestStartLine.

A failed Connect does not clear this value. It continues to describe the last request that was composed and sent.

Returns the request line from the most recently composed request. It contains the HTTP method, request target, and HTTP version, for example:

GET /v1/items?limit=10 HTTP/1.1

A failed Connect does not clear this value. It continues to describe the last request that was composed and sent.

Returns the number of response header field occurrences. Enumerate them with zero-based indexes using ResponseHdrName and ResponseHdrValue.

A failed Connect does not reset this count; it remains the count for the last received HTTP response.

Selects the multipart entity or part targeted by multipart-building operations such as AddHeader, RemoveHeader, and the SetMultipartBody* methods.

The value 0, like the empty string, selects the top-level request entity. A nonnumeric selector is invalid. A body assignment can create a higher-numbered part even when lower-numbered parts do not yet exist.

Applies to the full-request methods that both upload a request and download a response. It selects which direction is represented by percent-complete events.

• False (default): progress refers to receiving the response body.
• True: progress refers to sending the request body.

Returns the HTTP response header fields from the most recently received response, excluding the status line.

Repeated fields remain separate and in received order. The field-name casing is preserved. A failed Connect does not clear this value; it continues to describe the last received HTTP response.

Returns the numeric HTTP status code from the most recently received response, such as 200, 404, or 503.

Returns the reason phrase associated with the most recently received HTTP status code, such as OK or Not Found.

Controls whether streaming uploads use a Content-Length header instead of HTTP/1.1 chunked transfer encoding when the total body size is known. The default is True.

When True and the stream length can be determined—for example, a file stream—Chilkat sends a non-chunked request. When False, Chilkat uses Transfer-Encoding: chunked. If the stream length is unknown, chunked transfer may still be required.

Provides opt-in compatibility settings for uncommon requirements. The default is the empty string. Supply one or more comma-separated keywords:

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

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

Adds an HTTP request header using name as the field name and value as the field value. If a request header with the same name is already present for the selected part, its value is replaced.

Request headers persist across requests until removed or cleared. Adding the same header again replaces its current value.

Returns True for success, False for failure.

Computes the Amazon Marketplace Web Service (MWS) request signature using the secret key in mwsSecretKey and adds or replaces the Signature query parameter. Call this after all other MWS request parameters have been added.

httpVerb is the HTTP method, uriPath is the MWS resource path, and domain is the request domain. httpVerb and uriPath should match the values used by the request-sending method. The method also adds or replaces the Timestamp parameter using the current system time.

Returns True for success, False for failure.

Adds or replaces a path-substitution parameter. Before a request is sent, occurrences of name in the supplied request path are replaced by value.

For example, setting name to fileId and value to abc123 transforms /drive/v3/files/fileId into /drive/v3/files/abc123.

Matching is case-sensitive and literal. Every occurrence of name is replaced, substitutions are applied in the order they were added, and replacement applies to the entire uriPath string, including any query portion.

Path substitutions persist across requests until replaced or removed with ClearAllPathParams.

Returns True for success, False for failure.

Adds or replaces a query-string parameter using name as the parameter name and value as its value. The stored query parameters are incorporated into the request target when a request is sent.

Parameter names are case-sensitive. Adding the same exact name again replaces the existing value unless AllowDuplicateQueryParams is enabled in UncommonOptions.

Returns True for success, False for failure.

Adds multiple query parameters from the query-string text in queryString. Use the form field1=value1&field2=value2&field3=value3.

The input is parsed as an already URL-encoded query string and then normalized when the request is composed. A plus sign is interpreted as a space and is emitted as %20; encoded delimiters such as %26 remain data; an item without an equals sign is treated as a parameter with an empty value.

Parameters added by this method persist across ordinary requests. When ARG2 of a request method already contains a query string, those inline parameters appear first, followed by the parameters stored in the Rest object.

Returns True for success, False for failure.

Adds or replaces a query-string parameter named by name. The parameter value is read from the StringBuilder in value.

Parameter names are case-sensitive. Adding the same exact name again replaces the existing value unless AllowDuplicateQueryParams is enabled in UncommonOptions.

Returns True for success, False for failure.

Removes all HTTP request headers previously added to this object.

The method clears headers only from the entity selected by PartSelector. Clearing top-level headers also clears the Authorization property. Automatically generated fields such as Host and Content-Length may be added again when the next request is composed.

Returns True for success, False for failure.

Removes all multipart subparts from the request under construction. This is useful when reusing the same REST object after sending a multipart request.

This also resets PartSelector to the empty string and releases the configured multipart bodies and part streams.

Returns True for success, False for failure.

Removes all path-substitution parameters previously added with AddPathParam.

After clearing, placeholder text in later request paths is sent unchanged.

Returns True for success, False for failure.

Removes all query parameters previously added to this object.

This clears the stored query/form parameter collection. It does not remove a query string written directly in the uriPath argument of a request method.

Returns True for success, False for failure.

Clears authentication providers and credentials previously configured through this class's SetAuth* methods.

This removes the active authentication provider and clears the manually configured Authorization value.

Returns True for success, False for failure.

Clears the response-stream destination previously configured by SetResponseBodyStream. Subsequent full-request methods return or store the response body normally instead of streaming it to that destination.

Clearing the destination does not alter the Stream object itself.

Establishes the initial TCP connection to the REST server. hostname is a DNS hostname or an IPv4/IPv6 address, port is the server port, and tls specifies whether the connection uses TLS. Common combinations are port 80 with tls set to False, and port 443 with tls set to True.

If autoReconnect is True, subsequent requests may automatically reconnect when the existing connection is no longer usable. If autoReconnect is False, a lost connection causes the request to fail until the application explicitly reconnects.

Returns True for success, False for failure.

Creates an asynchronous task to call the Connect method with the arguments provided.

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 Nothing on failure

Closes the current HTTP connection, if one is open. maxWaitMs is the maximum number of milliseconds to wait while attempting a clean shutdown.

Returns True for success, False for failure.

Creates an asynchronous task to call the Disconnect method with the arguments provided.

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 Nothing on failure

Sends a complete request whose binary body is read from the BinData in binData. The text response body replaces the existing contents of the StringBuilder in responseBody.

responseBody is cleared and replaced with the textual response body.

Returns True for success, False for failure.

Creates an asynchronous task to call the FullRequestBd method with the arguments provided.

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 Nothing on failure

Sends a complete request whose body is the binary data in bodyBytes. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqBinaryBody, ReadResponseHeader, and ReadRespBodyString in sequence.

For full-request methods, PercentDoneOnSend selects whether percent-complete events refer to sending the request body or receiving the response body.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestBinary method with the arguments provided.

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 Nothing on failure

Sends a complete application/x-www-form-urlencoded request. The form body is built from the parameters previously added with AddQueryParam or AddQueryParams. The request Content-Type is set to application/x-www-form-urlencoded. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqFormUrlEncoded, ReadResponseHeader, and ReadRespBodyString in sequence.

For full-request methods, PercentDoneOnSend selects whether percent-complete events refer to sending the request body or receiving the response body.

Parameters written directly in uriPath remain in the URL query string. Parameters stored through AddQueryParam, AddQueryParamSb, or AddQueryParams are encoded into the form body. After the form request is sent, this stored parameter collection is cleared.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestFormUrlEncoded method with the arguments provided.

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 Nothing on failure

Sends a complete multipart request using the parts and part headers configured through PartSelector, AddHeader, and the multipart-body methods. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqMultipart, ReadResponseHeader, and ReadRespBodyString in sequence.

For full-request methods, PercentDoneOnSend selects whether percent-complete events refer to sending the request body or receiving the response body.

The request fails if no multipart subparts are configured.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestMultipart method with the arguments provided.

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 Nothing on failure

Sends a complete request with no request body. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqNoBody, ReadResponseHeader, and ReadRespBodyString in sequence.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestNoBody method with the arguments provided.

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 Nothing on failure

Sends a complete request without a request body and stores the binary response body in the BinData in binData, replacing its previous contents.

binData is cleared and replaced with the binary response body.

Returns True for success, False for failure.

Creates an asynchronous task to call the FullRequestNoBodyBd method with the arguments provided.

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 Nothing on failure

Sends a complete request without a request body and stores the text response body in the StringBuilder in sb, replacing its previous contents.

This is the StringBuilder form of FullRequestNoBody.

sb is cleared and replaced with the textual response body.

Returns True for success, False for failure.

Creates an asynchronous task to call the FullRequestNoBodySb method with the arguments provided.

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 Nothing on failure

Sends a complete request whose text body is read from the StringBuilder in requestBody. The text response body replaces the existing contents of the StringBuilder in responseBody.

This is the StringBuilder form of FullRequestString.

responseBody is cleared and replaced with the response body.

Returns True for success, False for failure.

Creates an asynchronous task to call the FullRequestSb method with the arguments provided.

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 Nothing on failure

Sends a complete request whose body is read from the Stream in stream. Streaming is appropriate for large uploads because the entire request body need not be held in memory. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqStreamBody, ReadResponseHeader, and ReadRespBodyString in sequence.

For full-request methods, PercentDoneOnSend selects whether percent-complete events refer to sending the request body or receiving the response body.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestStream method with the arguments provided.

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 Nothing on failure

Sends a complete request whose text body is supplied in bodyText, such as JSON, XML, or plain text. The response body is read as text and returned.

This convenience method performs the equivalent of SendReqStringBody, ReadResponseHeader, and ReadRespBodyString in sequence.

For full-request methods, PercentDoneOnSend selects whether percent-complete events refer to sending the request body or receiving the response body.

Returns Nothing on failure

Creates an asynchronous task to call the FullRequestString method with the arguments provided.

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 Nothing on failure

Copies the fully composed HTTP request generated while DebugMode was True into the BinData in bd. The captured data includes the request line, headers, and body that would have been sent.

bd is cleared and replaced. The captured bytes are the complete composed HTTP/1.1 request, including chunk framing when a streaming request uses Transfer-Encoding: chunked.

Returns True for success, False for failure.

Copies operation-specific diagnostic or result information from the most recently completed method into the JsonObject in json. Many methods do not produce additional JSON details, in which case the object is empty.

Loads into this object the caller associated with the Task in task. task must be a task returned by an asynchronous method of this class.

Returns True for success, False for failure.

Reads the response body as raw bytes into the BinData in responseBody, replacing its previous contents. Call this after ReadResponseHeader.

Returns True for success, False for failure.

Creates an asynchronous task to call the ReadRespBd method with the arguments provided.

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 Nothing on failure

Reads the response body as raw bytes. Call this only after ReadResponseHeader has returned the response status code.

Returns an empty byte array on failure

Creates an asynchronous task to call the ReadRespBodyBinary method with the arguments provided.

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 Nothing on failure

Reads the response body into the Stream supplied in stream. Call this after ReadResponseHeader.

If autoSetStreamCharset is True and the response is textual, the stream's StringCharset is set from the charset parameter in the response Content-Type header when one is present. autoSetStreamCharset has no effect for binary responses.

Returns True for success, False for failure.

Creates an asynchronous task to call the ReadRespBodyStream method with the arguments provided.

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 Nothing on failure

Reads the response body as text and returns it. Call this only after ReadResponseHeader has returned the response status code.

Returns Nothing on failure

Creates an asynchronous task to call the ReadRespBodyString method with the arguments provided.

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 Nothing on failure

After ReadResponseHeader has been called, reads the next chunk of the response body and appends the received bytes to the BinData in bd. The call waits until at least minSize bytes are available, unless the response ends first. The final chunk may contain fewer than minSize bytes, including zero bytes.

Returns True for success, False for failure.

Creates an asynchronous task to call the ReadRespChunkBd method with the arguments provided.

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 Nothing on failure

Reads the HTTP response status line and header fields. The returned integer is the HTTP status code, such as 200, 404, or 500. A return value of -1 means that no HTTP response was received because a transport or protocol error occurred.

After this method returns a status code, inspect ResponseHeader, ResponseStatusCode, ResponseStatusText, and the response-header access methods. If the response has a body, read it with ReadRespBodyString, ReadRespBd, ReadRespBodyStream, or another appropriate body-reading method.

Creates an asynchronous task to call the ReadResponseHeader method with the arguments provided.

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 Nothing on failure

Reads the response body as text into the StringBuilder in responseBody, replacing its previous contents. Call this after ReadResponseHeader.

Returns True for success, False for failure.

Creates an asynchronous task to call the ReadRespSb method with the arguments provided.

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 Nothing on failure

Removes all request headers named by name from the request level selected by PartSelector.

Header-name matching is case-insensitive, and all matching occurrences are removed.

Returns True for success, False for failure.

Removes all query parameters whose name matches name.

Parameter-name matching is case-sensitive. All parameters having the exact name are removed. A True return value indicates that the operation completed successfully; it does not guarantee that a matching parameter existed.

Returns True for success, False for failure.

Returns the value of the response header field named by name. HTTP header field names are case-insensitive.

If the response contains the same field more than once, this method returns the first matching value. Enumerate the header collection to obtain all occurrences, especially for fields such as Set-Cookie.

Returns Nothing on failure

Returns the field name of the response header at zero-based index index. Valid indexes range from 0 through NumResponseHeaders minus one.

Enumeration preserves the response-field order and the field-name casing received from the server. Repeated fields occupy separate indexes.

Returns Nothing on failure

Returns the field value of the response header at zero-based index index. Use the same index with ResponseHdrName to obtain the corresponding field name.

Repeated response fields occupy separate indexes and are returned in received order.

Returns Nothing on failure

Sends a request whose binary body is read from the BinData in body.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqBd method with the arguments provided.

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 Nothing on failure

Sends a request whose body is the binary byte array in body.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqBinaryBody method with the arguments provided.

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 Nothing on failure

Sends an application/x-www-form-urlencoded request. The request body is built from the parameters added with AddQueryParam or AddQueryParams. Any manually supplied Content-Type value is replaced with application/x-www-form-urlencoded.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Parameters written directly in uriPath remain in the URL query string. Parameters stored through AddQueryParam, AddQueryParamSb, or AddQueryParams are encoded into the form body. After the form request is sent, this stored parameter collection is cleared.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqFormUrlEncoded method with the arguments provided.

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 Nothing on failure

Sends a multipart request using the parts configured with PartSelector, AddHeader, and the multipart-body methods.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

The request fails if no multipart subparts are configured.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqMultipart method with the arguments provided.

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 Nothing on failure

Sends a request without a request body.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqNoBody method with the arguments provided.

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 Nothing on failure

Sends a request whose text body is read from the StringBuilder in bodySb. Set the request Content-Type header to identify the body format.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqSb method with the arguments provided.

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 Nothing on failure

Sends a request whose body is read from the Stream in stream. The stream may supply text or binary data; set the request Content-Type header as required by the API.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqStreamBody method with the arguments provided.

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 Nothing on failure

Sends a request whose text body is supplied in bodyText, such as JSON, XML, form-independent text, or another textual representation. Set the request Content-Type header to identify the body format expected by the server.

httpVerb is the HTTP method, such as GET, POST, or PUT. uriPath is the request path. This is a low-level send operation: after it succeeds, call ReadResponseHeader and then read the response body with the appropriate response method.

Returns True for success, False for failure.

Creates an asynchronous task to call the SendReqStringBody method with the arguments provided.

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 Nothing on failure

Associates the AuthAws provider in authProvider with this REST object. Chilkat uses the provider to sign each AWS request after the request method, path, query parameters, headers, and body are known. The application does not need to construct the Authorization header manually.

Returns True for success, False for failure.

Associates the AuthAzureSAS provider in authProvider with this REST object. Chilkat automatically adds an Authorization: SharedAccessSignature ... header to subsequent requests.

Returns True for success, False for failure.

Associates the AuthAzureStorage provider in authProvider with this REST object. Chilkat automatically applies the Azure Storage authorization information required for each request.

Returns True for success, False for failure.

Configures HTTP Basic authentication using username as the username and password as the password. Chilkat automatically generates an Authorization: Basic ... header for subsequent requests.

Some APIs use an account ID, client ID, API key, token, or secret in place of a traditional username or password; follow the service documentation.

Returns True for success, False for failure.

Configures HTTP Basic authentication using the SecureString objects in username and password for the username and password. The resulting request behavior is the same as SetAuthBasic.

Returns True for success, False for failure.

Associates the AuthGoogle provider in authProvider with this REST object. Chilkat uses the provider to add the Google authentication information needed by subsequent API requests.

Returns True for success, False for failure.

Associates the OAuth1 provider in authProvider with this REST object for OAuth 1.0 or OAuth 1.0a request signing.

If useQueryParams is True, the OAuth parameters and signature are placed in the query string. If useQueryParams is False, they are placed in the Authorization header.

Returns True for success, False for failure.

Associates the OAuth2 provider in authProvider with this REST object. The provider must contain a valid access token. Chilkat then adds an Authorization: Bearer <access-token> header to each request.

The access token may be obtained through an OAuth flow or loaded from previously saved token data. Token acquisition, refresh, expiration, and scope requirements are determined by the authorization server.

Returns True for success, False for failure.

Sets the binary body of the multipart part identified by PartSelector from the BinData in bodyData.

Setting the body creates the selected part when it does not already exist. Part numbers do not need to be created consecutively.

Returns True for success, False for failure.

Sets the selected multipart part body to the binary bytes in bodyData. The target part is identified by PartSelector.

Setting the body creates the selected part when it does not already exist. Part numbers do not need to be created consecutively.

Returns True for success, False for failure.

Sets the text body of the multipart part identified by PartSelector from the StringBuilder in bodySb.

Setting the body creates the selected part when it does not already exist. Part numbers do not need to be created consecutively.

Returns True for success, False for failure.

Uses the Stream in stream as the body source for the multipart part identified by PartSelector.

Setting the body creates the selected part when it does not already exist. Part numbers do not need to be created consecutively.

Returns True for success, False for failure.

Sets the text body of the multipart part identified by PartSelector to bodyText.

Setting the body creates the selected part when it does not already exist. Part numbers do not need to be created consecutively.

Returns True for success, False for failure.

Configures a Stream destination for response bodies received by the full-request convenience methods. The body is written to responseStream only when the response status code matches expectedStatus.

If streaming occurs successfully, a string-returning full-request method returns OK. If streaming was selected but writing the body fails, it returns FAIL. If the status code does not match expectedStatus, the body is not streamed and remains available as the method's normal response text.

If autoSetStreamCharset is True and the response is textual, the destination stream's StringCharset is set from the response Content-Type charset when available. autoSetStreamCharset is ignored for binary responses.

For Boolean-returning full-request methods, successful streaming returns True. A StringBuilder response output receives OK; a BinData response output is cleared. If the status does not match expectedStatus, the stream is not written and the method returns the response through its normal output.

The configuration remains active for later full-request calls until ClearResponseBodyStream is called.

Returns True for success, False for failure.

Uses the already-connected Socket in connection as the transport for REST requests. The socket may represent a direct TCP or TLS connection, an HTTP or SOCKS proxy connection, an SSH-tunneled channel, or another connection configured through the Socket API.

autoReconnect controls automatic reconnection for later requests when the connection is no longer usable.

Returns True for success, False for failure.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

Dim WithEvents rest As Chilkat.Rest

Private Sub rest_OnAbortCheck(sender As Object, args As Chilkat.AbortCheckEventArgs) Handles rest.OnAbortCheck

    ...

End Sub

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to True. This will cause the method to terminate and return a failure status or corresponding failure value.

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

Dim WithEvents rest As Chilkat.Rest

Private Sub rest_OnPercentDone(sender As Object, args As Chilkat.PercentDoneEventArgs) Handles rest.OnPercentDone

    ...

End Sub

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

Dim WithEvents rest As Chilkat.Rest

Private Sub rest_OnProgressInfo(sender As Object, args As Chilkat.ProgressInfoEventArgs) Handles rest.OnProgressInfo

    ...

End Sub

Called from the background thread when an asynchronous task completes.

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

Dim WithEvents rest As Chilkat.Rest

Private Sub rest_OnTaskCompleted(sender As Object, args As Chilkat.TaskCompletedEventArgs) Handles rest.OnTaskCompleted

    ...

End Sub

Deprecated. Use GetLastJsonData instead.

Returns a JSON object containing operation-specific details from the most recently completed method when such details are available. Many operations produce an empty object.

Returns Nothing on failure

Deprecated. Use LastRedirectUrl instead.

If the most recent response is a redirect and contains a Location header, returns that redirect URL.

Returns Nothing on failure