// CkHttpRequestW.h: interface for the CkHttpRequestW class. // ////////////////////////////////////////////////////////////////////// // This header is generated for Chilkat 9.5.0.75 #ifndef _CkHttpRequestW_H #define _CkHttpRequestW_H #include "chilkatDefs.h" #include "CkString.h" #include "CkWideCharBase.h" class CkByteData; class CkBinDataW; class CkStringBuilderW; #if !defined(__sun__) && !defined(__sun) #pragma pack (push, 8) #endif // CLASS: CkHttpRequestW class CK_VISIBLE_PUBLIC CkHttpRequestW : public CkWideCharBase { private: // Don't allow assignment or copying these objects. CkHttpRequestW(const CkHttpRequestW &); CkHttpRequestW &operator=(const CkHttpRequestW &); public: CkHttpRequestW(void); virtual ~CkHttpRequestW(void); static CkHttpRequestW *createNew(void); void CK_VISIBLE_PRIVATE inject(void *impl); // May be called when finished with the object to free/dispose of any // internal resources held by the object. void dispose(void); // BEGIN PUBLIC INTERFACE // ---------------------- // Properties // ---------------------- // Sets an explicit boundary string to be used in multipart/form-data requests. If // no Boundary is set, then a boundary string is automaticaly generated as needed // during the sending of a request. void get_Boundary(CkString &str); // Sets an explicit boundary string to be used in multipart/form-data requests. If // no Boundary is set, then a boundary string is automaticaly generated as needed // during the sending of a request. const wchar_t *boundary(void); // Sets an explicit boundary string to be used in multipart/form-data requests. If // no Boundary is set, then a boundary string is automaticaly generated as needed // during the sending of a request. void put_Boundary(const wchar_t *newVal); // Controls the character encoding used for HTTP request parameters for POST // requests. The default value is the ANSI charset of the computer. The charset // should match the charset expected by the form target. // // The "charset" attribute is only included in the Content-Type header of the // request if the SendCharset property is set to true. // void get_Charset(CkString &str); // Controls the character encoding used for HTTP request parameters for POST // requests. The default value is the ANSI charset of the computer. The charset // should match the charset expected by the form target. // // The "charset" attribute is only included in the Content-Type header of the // request if the SendCharset property is set to true. // const wchar_t *charset(void); // Controls the character encoding used for HTTP request parameters for POST // requests. The default value is the ANSI charset of the computer. The charset // should match the charset expected by the form target. // // The "charset" attribute is only included in the Content-Type header of the // request if the SendCharset property is set to true. // void put_Charset(const wchar_t *newVal); // The ContentType property sets the "Content-Type" header field, and identifies // the content-type of the HTTP request body. Common values are: // // // application/x-www-form-urlencoded // multipart/form-data // application/json // application/xml // // // If ContentType is set equal to the empty string, then no Content-Type header is // included in the HTTP request. void get_ContentType(CkString &str); // The ContentType property sets the "Content-Type" header field, and identifies // the content-type of the HTTP request body. Common values are: // // // application/x-www-form-urlencoded // multipart/form-data // application/json // application/xml // // // If ContentType is set equal to the empty string, then no Content-Type header is // included in the HTTP request. const wchar_t *contentType(void); // The ContentType property sets the "Content-Type" header field, and identifies // the content-type of the HTTP request body. Common values are: // // // application/x-www-form-urlencoded // multipart/form-data // application/json // application/xml // // // If ContentType is set equal to the empty string, then no Content-Type header is // included in the HTTP request. void put_ContentType(const wchar_t *newVal); // Composes and returns the entire MIME header of the HTTP request. void get_EntireHeader(CkString &str); // Composes and returns the entire MIME header of the HTTP request. const wchar_t *entireHeader(void); // Composes and returns the entire MIME header of the HTTP request. void put_EntireHeader(const wchar_t *newVal); // The HttpVerb property should be set to the name of the HTTP method that appears // on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It // is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, // MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to // anything, even custom verbs recognized by a custom server-side app. void get_HttpVerb(CkString &str); // The HttpVerb property should be set to the name of the HTTP method that appears // on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It // is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, // MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to // anything, even custom verbs recognized by a custom server-side app. const wchar_t *httpVerb(void); // The HttpVerb property should be set to the name of the HTTP method that appears // on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It // is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, // MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to // anything, even custom verbs recognized by a custom server-side app. void put_HttpVerb(const wchar_t *newVal); // The HTTP version in the request header. Defaults to "1.1". void get_HttpVersion(CkString &str); // The HTTP version in the request header. Defaults to "1.1". const wchar_t *httpVersion(void); // The HTTP version in the request header. Defaults to "1.1". void put_HttpVersion(const wchar_t *newVal); // Returns the number of request header fields. int get_NumHeaderFields(void); // Returns the number of query parameters. int get_NumParams(void); // The path of the resource requested. A path of "/" indicates the default document // for a domain. void get_Path(CkString &str); // The path of the resource requested. A path of "/" indicates the default document // for a domain. const wchar_t *path(void); // The path of the resource requested. A path of "/" indicates the default document // for a domain. void put_Path(const wchar_t *newVal); // Controls whether the charset is explicitly included in the content-type header // field of the HTTP POST request. The default value of this property is false. bool get_SendCharset(void); // Controls whether the charset is explicitly included in the content-type header // field of the HTTP POST request. The default value of this property is false. void put_SendCharset(bool newVal); // ---------------------- // Methods // ---------------------- // Adds a file to an upload request where the contents of the file come from an // in-memory byte array. To create a file upload request, call UseUpload and then // call AddBytesForUpload, AddStringForUpload, or AddFileForUpload for each file to // be uploaded. // // name is an arbitrary name. (In HTML, it is the form field name of the input // tag.) // remoteFileName is the name of the file to be created on the HTTP server. // byteData contains the contents (bytes) to be uploaded. // bool AddBytesForUpload(const wchar_t *name, const wchar_t *remoteFileName, CkByteData &byteData); // Same as AddBytesForUpload, but allows the Content-Type header field to be // directly specified. (Otherwise, the Content-Type header is automatically // determined based on the remoteFileName's file extension.) bool AddBytesForUpload2(const wchar_t *name, const wchar_t *remoteFileName, CkByteData &byteData, const wchar_t *contentType); // Adds a file to an upload request. To create a file upload request, call // UseUpload and then call AddFileForUpload, AddBytesForUpload, or // AddStringForUpload for each file to be uploaded. This method does not read the // file into memory. When the upload occurs, the data is streamed directly from the // file, thus allowing for very large files to be uploaded without consuming large // amounts of memory. // // name is an arbitrary name. (In HTML, it is the form field name of the input // tag.) // filePath is the path to an existing file in the local filesystem. // bool AddFileForUpload(const wchar_t *name, const wchar_t *filePath); // Same as AddFileForUpload, but allows the Content-Type header field to be // directly specified. (Otherwise, the Content-Type header is automatically // determined based on the file extension.) // // name is an arbitrary name. (In HTML, it is the form field name of the input // tag.) // filePath is the path to an existing file in the local filesystem. // bool AddFileForUpload2(const wchar_t *name, const wchar_t *filePath, const wchar_t *contentType); // Adds a request header to the HTTP request. If a header having the same field // name is already present, this method replaces it. // // Note: Never explicitly set the Content-Length header field. Chilkat will // automatically compute the correct length and add the Content-Length header to // all POST, PUT, or any other request where the Content-Length needs to be // specified. (GET requests always have a 0 length body, and therefore never need a // Content-Length header field.) // void AddHeader(const wchar_t *name, const wchar_t *value); // 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 // // Note: This method automatically adds or replaces the existing Timestamp // parameter to the current system date/time. // bool AddMwsSignature(const wchar_t *domain, const wchar_t *mwsSecretKey); // Adds a request query parameter (name/value pair) to the HTTP request. The name // and value strings passed to this method should not be URL encoded. void AddParam(const wchar_t *name, const wchar_t *value); // Same as AddFileForUpload, but the upload data comes from an in-memory string // instead of a file. bool AddStringForUpload(const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset); // Same as AddStringForUpload, but allows the Content-Type header field to be // directly specified. (Otherwise, the Content-Type header is automatically // determined based on the filename's file extension.) bool AddStringForUpload2(const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset, const wchar_t *contentType); // Adds a request header to the Nth sub-header of the HTTP request. If a header // having the same field name is already present, this method replaces it. bool AddSubHeader(int index, const wchar_t *name, const wchar_t *value); // The same as GenerateRequestText, except the generated request is written to the // file specified by path. bool GenerateRequestFile(const wchar_t *path); // Returns the request text that would be sent if Http.SynchronousRequest was // called. bool GenerateRequestText(CkString &outStr); // Returns the request text that would be sent if Http.SynchronousRequest was // called. const wchar_t *generateRequestText(void); // Returns the value of a request header field. bool GetHeaderField(const wchar_t *name, CkString &outStr); // Returns the value of a request header field. const wchar_t *getHeaderField(const wchar_t *name); // Returns the value of a request header field. const wchar_t *headerField(const wchar_t *name); // Returns the Nth request header field name. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. bool GetHeaderName(int index, CkString &outStr); // Returns the Nth request header field name. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. const wchar_t *getHeaderName(int index); // Returns the Nth request header field name. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. const wchar_t *headerName(int index); // Returns the Nth request header field value. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. bool GetHeaderValue(int index, CkString &outStr); // Returns the Nth request header field value. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. const wchar_t *getHeaderValue(int index); // Returns the Nth request header field value. Indexing begins at 0, and the number // of request header fields is specified by the NumHeaderFields property. const wchar_t *headerValue(int index); // Returns a request query parameter value by name. bool GetParam(const wchar_t *name, CkString &outStr); // Returns a request query parameter value by name. const wchar_t *getParam(const wchar_t *name); // Returns a request query parameter value by name. const wchar_t *param(const wchar_t *name); // Returns the Nth request query parameter field name. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. bool GetParamName(int index, CkString &outStr); // Returns the Nth request query parameter field name. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. const wchar_t *getParamName(int index); // Returns the Nth request query parameter field name. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. const wchar_t *paramName(int index); // Returns the Nth request query parameter field value. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. bool GetParamValue(int index, CkString &outStr); // Returns the Nth request query parameter field value. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. const wchar_t *getParamValue(int index); // Returns the Nth request query parameter field value. Indexing begins at 0, and // the number of request query parameter fields is specified by the NumParams // property. const wchar_t *paramValue(int index); // Returns the request parameters in URL encoded form (i.e. in the exact form that // would be sent if the ContentType property was // application/x-www-form-urlencoded). For example, if a request has two params: // param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return // "abc+123 bool GetUrlEncodedParams(CkString &outStr); // Returns the request parameters in URL encoded form (i.e. in the exact form that // would be sent if the ContentType property was // application/x-www-form-urlencoded). For example, if a request has two params: // param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return // "abc+123 const wchar_t *getUrlEncodedParams(void); // Returns the request parameters in URL encoded form (i.e. in the exact form that // would be sent if the ContentType property was // application/x-www-form-urlencoded). For example, if a request has two params: // param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return // "abc+123 const wchar_t *urlEncodedParams(void); // Uses the contents of the requestBody as the HTTP request body. bool LoadBodyFromBd(CkBinDataW &requestBody); // The HTTP protocol is such that all HTTP requests are MIME. For non-multipart // requests, this method may be called to set the MIME body of the HTTP request to // the exact contents of the byteData. // Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME // header fields, and (3) the MIME body. This method sets the MIME body. bool LoadBodyFromBytes(CkByteData &byteData); // The HTTP protocol is such that all HTTP requests are MIME. For non-multipart // requests, this method may be called to set the MIME body of the HTTP request to // the exact contents of filePath. // Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME // header fields, and (3) the MIME body. This method sets the MIME body. bool LoadBodyFromFile(const wchar_t *filePath); // Uses the contents of the requestBody as the HTTP request body. The charset indicates the // binary representation of the string, such as "utf-8", "utf-16", "iso-8859-*", // "windows-125*", etc. Any of the character encodings supported at the link below // are valid. bool LoadBodyFromSb(CkStringBuilderW &requestBody, const wchar_t *charset); // The HTTP protocol is such that all HTTP requests are MIME. For non-multipart // requests, this method may be called to set the MIME body of the HTTP request to // the exact contents of bodyStr. // Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME // header fields, and (3) the MIME body. This method sets the MIME body. // // charset indicates the charset, such as "utf-8" or "iso-8859-1", to be used. The // HTTP body will contain the bodyStr converted to this character encoding. // bool LoadBodyFromString(const wchar_t *bodyStr, const wchar_t *charset); // Removes all request parameters. void RemoveAllParams(void); // Removes all occurrences of a HTTP request header field. Always returns true. bool RemoveHeader(const wchar_t *name); // Removes a single HTTP request parameter by name. void RemoveParam(const wchar_t *name); // Parses a URL and sets the Path and query parameters (NumParams, GetParam, // GetParamName, GetParamValue). void SetFromUrl(const wchar_t *url); // Useful for sending HTTP requests where the body is a very large file. For // example, to send an XML HttpRequest containing a very large XML document, one // would set the HttpVerb = "POST", the ContentType = "text/xml", and then call // StreamBodyFromFile to indicate that the XML body of the request is to be // streamed directly from a file. When the HTTP request is actually sent, the body // is streamed directly from the file, and thus the file never needs to be loaded // in its entirety in memory. bool StreamBodyFromFile(const wchar_t *filePath); // This method is the same as StreamBodyFromFile, but allows for an offset and // number of bytes to be specified. The offset and numBytes are integers passed as // strings. bool StreamChunkFromFile(const wchar_t *path, const wchar_t *offset, const wchar_t *numBytes); // Makes the HttpRequest a GET request. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "GET", and the ContentType equal to an empty string // (because GET requests have no request body). // void UseGet(void); // Makes the HttpRequest a HEAD request. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "HEAD", and the ContentType equal to an empty string // (because HEAD requests have no body). // void UseHead(void); // Makes the HttpRequest a POST request that uses the // "application/x-www-form-urlencoded" content type. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "POST", and the ContentType equal to // "application/x-www-form-urlencoded". // void UsePost(void); // Makes the HttpRequest a POST request that uses the "multipart/form-data" content // type. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "POST", and the ContentType equal to // "multipart/form-data". // void UsePostMultipartForm(void); // Makes the HttpRequest a PUT request. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "PUT", and the ContentType equal to // "application/x-www-form-urlencoded". // void UsePut(void); // Makes the HttpRequest a POST request that uses the "multipart/form-data" content // type. To create a file upload request, call UseUpload and then call // AddFileForUpload for each file to be uploaded. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "POST", and the ContentType equal to // "multipart/form-data". // void UseUpload(void); // Makes the HttpRequest a PUT request that uses the "multipart/form-data" content // type. To create a file upload request (using the PUT verb), call UseUploadPut // and then call AddFileForUpload for each file to be uploaded. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "PUT", and the ContentType equal to // "multipart/form-data". // void UseUploadPut(void); // Makes the HttpRequest a POST request using the "application/xml" content type. // The request body is set to the XML string passed to this method. // // Important: This method is deprecated. An application should instead set the // HttpVerb property equal to "POST", the ContentType equal to "text/xml", and the // request body should contain the XML document text. // void UseXmlHttp(const wchar_t *xmlBody); // END PUBLIC INTERFACE }; #if !defined(__sun__) && !defined(__sun) #pragma pack (pop) #endif #endif