sendCustomRequest (method)
Sends a custom request to the Backblaze B2 API.
Syntax
- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)operation :(NSString*)requestBody;
public func sendCustomRequest(_ httpMethod: String, _ operation: String, _ requestBody: String) throws -> Void
Remarks
This method can be used to send arbitrary requests to the Backblaze B2 API.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
The value passed for Operation must be one of the API operations described in the Backblaze B2 REST API documentation (e.g., b2_list_buckets).
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, as follows:
- The specified Operation is appended to the base Backblaze B2 API URL (refer to the APIURL configuration setting for more information).
- All query parameters in the QueryParam* properties are added to the request URL.
- Sends the request using the specified HttpMethod, the request URL built in step 1, the header information built from AccountAuthToken and OtherHeaders, and the given RequestBody (if non-empty).
- Stores the response headers in the ParsedHeader* properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.