![]() System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/Base/Reference/ |
Upload File : |
<?xml version="1.0"?> <!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd"> <gsdoc base="NSURLRequest" up="Base"> <head> <title>NSURLRequest documentation</title> <author name="Generated by Debian"></author> </head> <body> <front><contents /></front> <chapter> <heading> Software documentation for the NSMutableURLRequest class </heading> <class name="NSMutableURLRequest" super="NSURLRequest" ovadd="10.2.0" gvadd="1.13.0"> <declared>Foundation/NSURLRequest.h</declared> <desc> <em>Description forthcoming.</em> </desc> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setCachePolicy:</sel> <arg type="NSURLRequestCachePolicy">cachePolicy</arg> <desc> Sets the receiver's cache policy. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setMainDocumentURL:</sel> <arg type="NSURL*">URL</arg> <desc> Sets the receiver's main document. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setTimeoutInterval:</sel> <arg type="NSTimeInterval">seconds</arg> <desc> Sets the receiver's timeout policy. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setURL:</sel> <arg type="NSURL*">URL</arg> <desc> Sets the receiver's <var>URL</var> </desc> </method> </class> </chapter> <chapter> <heading> Software documentation for the NSURLRequest class </heading> <class name="NSURLRequest" super="NSObject" ovadd="10.2.0" gvadd="1.13.0"> <declared>Foundation/NSURLRequest.h</declared> <conform>NSCoding</conform> <conform>NSCopying</conform> <conform>NSMutableCopying</conform> <desc> This class encapsulates information about a request to load a URL, how to cache the results, and when to deal with a slow/hung load process by timing out. </desc> <ivariable type="void*" name="_NSURLRequestInternal" validity="protected" ovadd="10.2.0" gvadd="1.13.0"> <desc> <em>Warning</em> the underscore at the start of the name of this instance variable indicates that, even though it is not technically <em>private</em>, it is intended for internal use within the package, and you should not use the variable in other code. </desc> </ivariable> <method type="id" factory="yes" ovadd="10.2.0" gvadd="1.13.0"> <sel>requestWithURL:</sel> <arg type="NSURL*">URL</arg> <desc> <em>Description forthcoming.</em> </desc> </method> <method type="id" factory="yes" ovadd="10.2.0" gvadd="1.13.0"> <sel>requestWithURL:</sel> <arg type="NSURL*">URL</arg> <sel>cachePolicy:</sel> <arg type="NSURLRequestCachePolicy">cachePolicy</arg> <sel>timeoutInterval:</sel> <arg type="NSTimeInterval">timeoutInterval</arg> <desc> Returns an autoreleased instance initialised with the specified <var>URL</var>, <var>cachePolicy</var>, and <var>timeoutInterval</var>. </desc> </method> <method type="NSURL*" ovadd="10.2.0" gvadd="1.13.0"> <sel>URL</sel> <desc> Returns the URL associated with the receiver. </desc> </method> <method type="NSURLRequestCachePolicy" ovadd="10.2.0" gvadd="1.13.0"> <sel>cachePolicy</sel> <desc> Returns the cache policy associated with the receiver. </desc> </method> <method type="id" ovadd="10.2.0" gvadd="1.13.0"> <sel>initWithURL:</sel> <arg type="NSURL*">URL</arg> <desc> Initialises the reveiver with the specified <var>URL</var> and with the default cache policy (NSURLRequestUseProtocolCachePolicy) and a sixty second timeout. </desc> </method> <method type="id" ovadd="10.2.0" gvadd="1.13.0"> <sel>initWithURL:</sel> <arg type="NSURL*">URL</arg> <sel>cachePolicy:</sel> <arg type="NSURLRequestCachePolicy">cachePolicy</arg> <sel>timeoutInterval:</sel> <arg type="NSTimeInterval">timeoutInterval</arg> <desc> Initialises the receiver with the specified <var>URL</var>, <var>cachePolicy</var>, and <var>timeoutInterval</var>. </desc> </method> <method type="NSURL*" ovadd="10.2.0" gvadd="1.13.0"> <sel>mainDocumentURL</sel> <desc> Returns the main document URL for the receiver. <br /> Currently unused. <br /> This is intended for use with frames and similar situations where a main document has a large number of subsidiary documents. </desc> </method> <method type="NSTimeInterval" ovadd="10.2.0" gvadd="1.13.0"> <sel>timeoutInterval</sel> <desc> Returns the timeout interval associated with the receiver. <br /> This is a value in seconds specifying how <strong>long</strong> the load process may be inactive (waiting for data to arrive from the server) before the load is mconsidered to have failed due to a timeout. </desc> </method> </class> </chapter> <chapter> <heading> Software documentation for the NSMutableURLRequest(NSMutableHTTPURLRequest) category </heading> <category name="NSMutableHTTPURLRequest" class="NSMutableURLRequest" ovadd="10.2.0" gvadd="1.13.0"> <declared>Foundation/NSURLRequest.h</declared> <desc> <em>Description forthcoming.</em> </desc> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>addValue:</sel> <arg type="NSString*">value</arg> <sel>forHTTPHeaderField:</sel> <arg type="NSString*">field</arg> <desc> Appends the <var>value</var> to the specified header <var>field</var>, automatically inserting a comman <var>field</var> delimiter if necessary. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setAllHTTPHeaderFields:</sel> <arg type="NSDictionary*">headerFields</arg> <desc> Sets all the string values in the supplied <var>headerFields</var> dictionary as header values in the receiver. <br /> Non-string values are ignored. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setHTTPBody:</sel> <arg type="NSData*">data</arg> <desc> Sets the <var>data</var> to be sent as the body of the HTTP request. <br /> Clears any value previously set by <ref type="method" id="-setHTTPBodyStream:"> -setHTTPBodyStream: </ref> or <ref type="method" id="-setHTTPBody:"> -setHTTPBody: </ref> </desc> </method> <method type="void" ovadd="10.4.0" gvadd="1.13.0"> <sel>setHTTPBodyStream:</sel> <arg type="NSInputStream*">inputStream</arg> <desc> Sets the request body to be the contents of the given stream. <br /> The stream should be unopened when it is set, and the load process for the request will open the stream and read its entire content forwarding it to the remote server. <br /> Clears any value previously set by <ref type="method" id="-setHTTPBody:"> -setHTTPBody: </ref> or <ref type="method" id="-setHTTPBodyStream:"> -setHTTPBodyStream: </ref> </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setHTTPMethod:</sel> <arg type="NSString*">method</arg> <desc> Sets the <var>method</var> of the receiver. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setHTTPShouldHandleCookies:</sel> <arg type="BOOL">should</arg> <desc> Sets a flag to say whether cookies <var>should</var> automatically be added to the request and whether cookies in the response <var>should</var> be used. </desc> </method> <method type="void" ovadd="10.2.0" gvadd="1.13.0"> <sel>setValue:</sel> <arg type="NSString*">value</arg> <sel>forHTTPHeaderField:</sel> <arg type="NSString*">field</arg> <desc> Sets the <var>value</var> for the sapecified header <var>field</var>, replacing any previously set <var>value</var>. </desc> </method> </category> </chapter> <chapter> <heading> Software documentation for the NSURLRequest(NSHTTPURLRequest) category </heading> <category name="NSHTTPURLRequest" class="NSURLRequest" ovadd="10.2.0" gvadd="1.13.0"> <declared>Foundation/NSURLRequest.h</declared> <desc> HTTP specific additions to NSURLRequest </desc> <method type="NSData*" ovadd="10.2.0" gvadd="1.13.0"> <sel>HTTPBody</sel> <desc> Returns the body of the reques... this is the data sent in a POST request. </desc> </method> <method type="NSInputStream*" ovadd="10.4.0" gvadd="1.13.0"> <sel>HTTPBodyStream</sel> <desc> Returns the currently set stream (if any) to be used to provide data to send as the request body. <br /> Of course, any attempt to modify this stream may mess up the load operation in progress. </desc> </method> <method type="NSString*" ovadd="10.2.0" gvadd="1.13.0"> <sel>HTTPMethod</sel> <desc> Returns the HTTP method assiciated with the receiver. </desc> </method> <method type="BOOL" ovadd="10.2.0" gvadd="1.13.0"> <sel>HTTPShouldHandleCookies</sel> <desc> Returns a flag indicating whether this request should use standard cookie handling (sending of cookies with the request and storing any cookies returned in the response. </desc> </method> <method type="NSDictionary*" ovadd="10.2.0" gvadd="1.13.0"> <sel>allHTTPHeaderFields</sel> <desc> Returns a dictionary of the HTTP header fields associated with the receiver. </desc> </method> <method type="NSString*" ovadd="10.2.0" gvadd="1.13.0"> <sel>valueForHTTPHeaderField:</sel> <arg type="NSString*">field</arg> <desc> Returns the value for a particular HTTP header <var>field</var> (by case insensitive comparison) or <code>nil</code> if no such header is set. </desc> </method> </category> </chapter> </body> </gsdoc>