NSHTTPCookie类详解

sofh7777

继承自	NSObject的
符合	NSObject的（NSObject的）
框架	/系统/资源库/框架/ Foundation.framework
可用性	安装使用Safari 1.0在Mac OS X V10.2。 在Mac OS X v10.2.7和更高的市场。
伴侣指南	URL加载系统编程指南
宣布	NSHTTPCookie.h

概述
　　NSHTTPCookie对象代表一个HTTP cookie。 这是一个不可改变的对象，从一个包含cookie的属性的字典初始化。
　　两种版本都支持Cookie的：

• 　　0版：这个版本是指“传统”或“旧式”饼干，原来的cookie的格式是由Netscape定义。 大多数遇到的cookie是在这种格式。
  
  
• 　　第1版：这个版本是指定义在RFC 2965 HTTP状态管理机制的cookies。
  
  

　　

通过的议定书
　　


NSCopying

• 　　– copyWithZone:
  
  

任务

创建Cookie实例

• + cookiesWithResponseHeaderFields:forURL:
  
• + cookieWithProperties:
  
• – initWithProperties:
  

转换请求头的cookie

• + requestHeaderFieldsWithCookies:
  

获取Cookie属性

• – comment
  
• – commentURL
  
• – domain
  
• – expiresDate
  
• – isHTTPOnly
  
• – isSecure
  
• – isSessionOnly
  
• – name
  
• – path
  
• – portList
  
• – properties
  
• – value
  
• – version
  

　　

类方法



cookiesWithResponseHeaderFields：forURL：
　　返回NSHTTPCookie对象提供的网址所提供的响应头字段对应的数组。


+（ NSArray的 *）cookiesWithResponseHeaderFields：（ NSDictionary *）headerFields forURL：（ NSURL *）theURL


参数

headerFields　　头字段用于创建的NSHTTPCookie对象。

theURL　　网址相关联的创建的cookie。




返回值
　　创建的cookie数组。



讨论
　　这种方法忽略headerFields无关的头字段，允许字典包含额外的数据。
　　， 如果 headerFields不指定一个给定的cookie的域，cookie是创建一个theURL的默认域值。
　　如果headerFields不指定为一个给定的cookie的路径，Cookie是创建一个“/”的默认路径值。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


cookieWithProperties：
　　创建并初始化一个NSHTTPCookie对象，使用提供的属性。


+（ID）cookieWithProperties：（ NSDictionary *） 属性


参数

属性　　新的Cookie对象的属性，表示为键值对。




返回值
　　新创建的cookie对象。 nil nil ，如果提供的属性是无效的。



讨论
　　可用的头字段常量的价值观强加在字典中的约束更多信息，请参阅“常量 “ 。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

另请参见

• – initWithProperties:
  

宣布

NSHTTPCookie.h


requestHeaderFieldsWithCookies：
　　返回头字段对应的饼干提供的数组字典。


+（ NSDictionary *）requestHeaderFieldsWithCookies是： （NSArray的*）饼干


参数

饼干　　头字段创建的cookie。




返回值
　　从所提供的Cookie字典中创建的头字段。 可以使用这本词典添加到请求的cookie。



讨论
　　头字段的键和返回字典的值的详细信息，请参阅“常量”。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


实例方法



评论
　　返回接收器的注释字符串。


- （ NSString的 *）发表评论


返回值
　　接收机的注释字符串或nil ，如果cookie没有评论。 这个字符串是适合呈现给用户，说明这个cookie的内容和目的。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


commentURL
　　返回的接收器的评论URL。


- （ NSURL *）commentURL


返回值
　　评论的网址或接收器的nil ，如果cookie没有。 此值指定一个URL，这是适合提交关于这个cookie的进一步信息的链接用户。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


域
　　返回接收器的cookie的域。


- （ NSString的 *）域


返回值
　　接收器的cookie的域。



讨论
　　如果该域不以点开始的，然后只发送cookie的域所指定的确切主机。 如果该域并以点开始，那么该Cookie发送到其他主机，以及在该领域，受到一定的限制。 更多细节，请参阅RFC 2965。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


expiresDate
　　返回接收的截止日期。


- （ NSDate的 *）expiresDate


返回值
　　接收器的到期日期，如在“会话”曲奇的情况下，如果没有具体的到期nil ，或无。 失效日期应删除cookie的日期。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


initWithProperties：
　　返回一个初始化NSHTTPCookie的对象，使用提供的属性。


- （ID）initWithProperties：（ NSDictionary *） 属性


参数

属性　　新的Cookie对象的属性，表示为键值对。




返回值
　　初始化Cookie对象。 nil nil ，如果提供的属性是无效的。



讨论
　　可用的头字段常量的价值观强加在字典中的约束更多信息，请参阅“常量 “ 。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

另请参见

• + cookieWithProperties:
  

宣布

NSHTTPCookie.h


isHTTPOnly
　　返回接收者是否应该只被发送到每个RFC 2965的HTTP服务器。


- （BOOL）isHTTPOnly


返回值
　　如果这个cookie只能通过HTTP头发送， YES NO ，否则， YES YES 。



讨论
　　Cookies可能会被标记为HTTP只能由一个服务器（或由JavaScript）。 作为标记的Cookies设置必须通过HTTP头只发送HTTP请求的URL匹配各自的cookie路径和域。


　　重要事项 ：为HTTP指定的Cookie不应交付任何JavaScript应用程序，以防止跨站点脚本漏洞。
　　



可用性

• 在Mac OS X v10.6中和以后。
  

宣布

NSHTTPCookie.h


isSecure
　　返回他的cookie是否只应通过安全通道发送。


- （BOOL）isSecure


返回值
　　如果这个cookie只应该是通过安全通道发送，否则NO 。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


isSessionOnly
　　返回接收器是否应该被丢弃在会议结束时（不论到期日期）。


- （BOOL）isSessionOnly


返回值
　　如果接收器应丢弃在会议结束时（不论到期日期），否则NO 。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


名称
　　返回接收器的名称。


- （ NSString的 *）的名称


返回值
　　接收器的名称。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


路径
　　返回接收器的路径。


- （ NSString的 *）路径


返回值
　　接收器的路径。



讨论
　　这条道路的要求，在cookie的域，这个前缀的所有路径，cookie将被发送。 “/”的路径，域，cookie将被所有的URL发送。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


portList
　　返回接收机的端口列表。


- （ NSArray的 *）portList


返回值
　　Cookie的港口名单，作为NSNumber对象包含整数数组返回。 如果cookie没有端口列表，此方法nil nil，cookie将被发送到任何端口。 否则，Cookie是只发送到指定端口的端口列表。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


属性
　　返回接收器的Cookie属性。


- （ NSDictionary *）属性


返回值
　　一个接收器的Cookie属性的字典表示。



讨论
　　可以使用这本词典initWithProperties:或cookieWithProperties: ，以创建一个NSHTTPCookie NSHTTPCookie对象。
　　initWithProperties:为更多的属性字典的约束信息。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


价值
　　返回接收的价值。


- （ NSString的 *）的值


返回值
　　接收器的价值。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


版本
　　返回接收器的版本。


- （ NSUInteger ）版本


返回值
　　接收器的版本。 0版本的地图“旧式”的Netscape的cookie。 版本1映射到RFC 2965的cookies。



可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h


常量

HTTP cookie的属性键
　　这些常量定义在一个包含cookie的属性的字典支持的键。

外部的NSString * NSHTTPCookieComment ;
外部的NSString * NSHTTPCookieCommentURL ;
外部的NSString * NSHTTPCookieDiscard ;
外部的NSString * NSHTTPCookieDomain ;
外部的NSString * NSHTTPCookieExpires ;
外部的NSString * NSHTTPCookieMaximumAge ;
外部的NSString * NSHTTPCookieName ;
外部的NSString * NSHTTPCookieOriginURL ;
外部的NSString * NSHTTPCookiePath ;
外部的NSString * NSHTTPCookiePort ;
外部的NSString * NSHTTPCookieSecure ;
外部的NSString * NSHTTPCookieValue ;
外部的NSString * NSHTTPCookieVersion ;

常量

NSHTTPCookieComment　　NSString NSString对象，其中包含Cookie的评论。
　　仅适用于第1版饼干和更高的有效。 这头字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieCommentURL　　一个NSURL对象NSString对象包含Cookie的评论的网址。
　　只有有效的版本1的cookies或更高版本。 这头字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieDiscard　　说明cookie是否应在会议结束时丢弃NSString NSString对象。
　　字符串值必须是“true”或“假”。 这头字段是可选的。 默认为“假”，除非这是Cookie是第1版或以上，价值NSHTTPCookieMaximumAge未指定，在这种情况下，，它被假定为“TRUE” 。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieDomain　　NSString NSString对象，其中包含Cookie的域。
　　要么NSHTTPCookieDomain或NSHTTPCookieOriginURL必须指定一个值。 如果缺少这个头字段域推断从价值NSHTTPCookieOriginURL 。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieExpires　　一个NSDate对象或NSString对象指定Cookie的到期日期。
　　这头字段仅用于版本0的cookie。 这头字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieMaximumAge　　NSString NSString对象，包含一个整数，说明多久，在几秒钟内的Cookie应保持在最，。
　　仅适用于第1版饼干和更高的有效。 默认为“0”。 此字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieName　　NSString NSString对象，其中包含的cookie的名称。 此字段是必需的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieOriginURL　　一个NSURL或NSString对象，其中包含的URL设置这个cookie。
　　要么NSHTTPCookieDomain或NSHTTPCookieOriginURL必须指定一个值。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookiePath　　NSString NSString对象，包含cookie的路径。 此字段是必需的，如果你正在使用的NSHTTPCookieDomain的关键，而不是NSHTTPCookieOriginURL关键。
　　如果您使用NSHTTPCookieOriginURL的关键，该路径是推断，如果它没有提供。 默认值是“/”。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookiePort　　NSString NSString对象，其中包含逗号分隔的整数指定cookie的端口值。
　　只有有效的版本1的cookies或更高版本。 默认值是一个空字符串(""). 这头字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieSecure　　表明，该cookie应只通过安全通道传输NSString NSString对象。
　　提供任何此键的值表示该Cookie应保持安全。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieValue　　NSString NSString对象，其中包含cookie的值。
　　这头字段是必需的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。

NSHTTPCookieVersion　　NSString NSString对象，指定cookie的版本。
　　必须是“0”或“1”。 默认为“0”。 这头字段是可选的。
　　可在Mac OS X V10.2和更高版本。
　　声明中NSHTTPCookie.h 。




可用性

• 安装使用Safari 1.0在Mac OS X V10.2。
  
• 在Mac OS X v10.2.7和更高的市场。
  

宣布

NSHTTPCookie.h