/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSHTTPCookie.html is in gnustep-base-doc 1.24.7-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | <!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 root</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-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-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">
Returns whether the receiver should only be sent
over secure connections.
</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">
Returns whether the receiver should be destroyed at
the end of the session.
</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>
|