Server : Apache/2.4.41 (Ubuntu) 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 :
Current File : //usr/share/doc/gnustep-base-doc/Base/Reference/NSHTTPCookie.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSHTTPCookie class documentation</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSHTTPCookie">NSHTTPCookie class documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Generated by Debian</dt>
<dd>
</dd>
</dl>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSHTTPCookie class
</a></h1>
<h2><a name="class$NSHTTPCookie">NSHTTPCookie</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSHTTPCookie.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
An instance of the NSHTTPCookie class is a single,
immutable http cookie. It can be initialised with
properties from a dictionary and has accessor
methods to obtain the cookie values. <br /> The class
supports unversioned cookies (sometimes referred to
as version 0) as originally produced by netscape, as well
as more recent standardised and versioned cookies.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie+cookieWithProperties$">+cookieWithProperties:</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie+cookiesWithResponseHeaderFields$forURL$">+cookiesWithResponseHeaderFields:forURL:</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie+requestHeaderFieldsWithCookies$">+requestHeaderFieldsWithCookies:</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-comment">-comment</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-commentURL">-commentURL</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-domain">-domain</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-expiresDate">-expiresDate</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-initWithProperties$">-initWithProperties:</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-isHTTPOnly">-isHTTPOnly</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-isSecure">-isSecure</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-isSessionOnly">-isSessionOnly</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-name">-name</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-path">-path</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-portList">-portList</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-properties">-properties</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-value">-value</a></li>
<li><a rel="gsdoc" href="NSHTTPCookie.html#method$NSHTTPCookie-version">-version</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSHTTPCookie+cookieWithProperties$">cookieWithProperties: </a></h3>
+ (id) <b>cookieWithProperties:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)properties;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Allocates and returns an autoreleasd instance
using
<a rel="gsdoc" href="#method$NSHTTPCookie-initWithProperties$">
-initWithProperties:
</a>
to initialise it from <var>properties</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie+cookiesWithResponseHeaderFields$forURL$">cookiesWithResponseHeaderFields: forURL: </a></h3>
+ (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>cookiesWithResponseHeaderFields:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)headerFields<b> forURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)URL;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns an array of cookies parsed from the
<var>headerFields</var> and <var>URL</var> (assuming
that the <var>headerFields</var> came from a response
to a request sent to the <var>URL</var>). <br /> The
<var>headerFields</var> dictionary must contain at
least all the headers relevant to cookie setting...
other headers are ignored.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie+requestHeaderFieldsWithCookies$">requestHeaderFieldsWithCookies: </a></h3>
+ (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>requestHeaderFieldsWithCookies:</b> (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*)cookies;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns a dictionary of header fields that can be
used to add the specified <var>cookies</var> to a
request.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-comment">comment </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>comment</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns a string which may be used to describe the
cookie to the user, or <code>nil</code> if no
comment is set.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-commentURL">commentURL </a></h3>
- (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*) <b>commentURL</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns a URL where the user can find out about the
cookie, or <code>nil</code> if no comment URL is
set.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-domain">domain </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>domain</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the domain to which the cookie should be
sent. <br /> If there is a leading dot then
subdomains should also receive the cookie as
specified in RFC 2965.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-expiresDate">expiresDate </a></h3>
- (<a rel="gsdoc" href="NSDate.html#class$NSDate">NSDate</a>*) <b>expiresDate</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the expiry date of the receiver or
<code>nil</code> if there is no such date.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-initWithProperties$">initWithProperties: </a></h3>
- (id) <b>initWithProperties:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)properties;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialises the receiver with a dictionary of
<var>properties</var>. <br /> Unrecognised keys are
ignored. <br /> Returns <code>nil</code> if a
required key is missing or if an illegal value is
specified for a key.
<dl>
<dt>NSHTTPCookieComment</dt>
<dd>
The
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
comment for the cookie (if any). <br /> This
is <code>nil</code> by default and for unversioned
cookies.
</dd>
<dt>NSHTTPCookieCommentURL</dt>
<dd>
The
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
or
<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>
URL to get the comment for the cookie. <br />
This is <code>nil</code> by default and for
unversioned cookies.
</dd>
<dt>NSHTTPCookieDomain</dt>
<dd>
The
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
specified the domain to which the
cookie applies. <br /> This is extracted
from NSHTTPCookieOriginURL if not
specified.
</dd>
<dt>NSHTTPCookieDiscard</dt>
<dd>
A
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
(either TRUE or FALSE) saying whether
the cookie is to be discarded when the
session ends. <br /> Defaults to
FALSE except for versioned cookies
where NSHTTPCookieMaximumAge is
unspecified.
</dd>
<dt>NSHTTPCookieExpires</dt>
<dd>
The
<a rel="gsdoc" href="NSDate.html#class$NSDate">NSDate</a>
or
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
(format Wdy, DD-Mon-YYYY HH:MM:SS GMT) specifying when an unversioned cookie expires and ignored for versioned cookies.
</dd>
<dt>NSHTTPCookieMaximumAge</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
containing an integer value specifying the longest time (in seconds) for which the cookie is valid. <br /> This defaults to zero and is only meaningful for versioned cookies.
</dd>
<dt>NSHTTPCookieName</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
... obvious... no default value.
</dd>
<dt>NSHTTPCookieOriginURL</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
or
<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>
specifying the URL which set the cookie. <br /> Must be supplied if NSHTTPCookieDomain is not.
</dd>
<dt>NSHTTPCookiePath</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
specifying the path from the cookie. <br /> If unspecified this value is determined from NSHTTPCookieOriginURL or defaults to '/'.
</dd>
<dt>NSHTTPCookiePort</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
containing a comma separated list of integer port numbers. This is valid for versioned cookies and defaults to an empty string.
</dd>
<dt>NSHTTPCookieSecure</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
saying whether the cookie may be sent over insecure connections. <br /> The default is FALSE meaning that it may be sent insecurely.
</dd>
<dt>NSHTTPCookieValue</dt>
<dd>
An
<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
containing the whole value of the cooke. <br /> This parameter <strong>must</strong> be provided.
</dd>
<dt>NSHTTPCookieVersion</dt>
<dd>
An <a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>
specifying the cookie version... for an unversioned cookie (the default) this is '0'. <br /> Also supports version '1'.
</dd>
</dl>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-isHTTPOnly">isHTTPOnly </a></h3>
- (BOOL) <b>isHTTPOnly</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-isSecure">isSecure </a></h3>
- (BOOL) <b>isSecure</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-isSessionOnly">isSessionOnly </a></h3>
- (BOOL) <b>isSessionOnly</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-name">name </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the name of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-path">path </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>path</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the URL path within the cookie's domain for
which this cookie must be sent.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-portList">portList </a></h3>
- (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>portList</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the list of ports to which the receiver
should be sent, or <code>nil</code> if the cookie
can be used for any port.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-properties">properties </a></h3>
- (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>properties</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns a dictionary representation of the receiver
which could be used as the argument for
<a rel="gsdoc" href="#method$NSHTTPCookie-initWithProperties$">
-initWithProperties:
</a>
to recreate a copy of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-value">value </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>value</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the value of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSHTTPCookie-version">version </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>version</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns 0 for an unversioned Netscape style cookie
or a positive integer for a versioned cookie.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)