matlab.net.http.CookieInfo class

Package:matlab.net.http

HTTP cookie information

expand all in page

Description

TheCookieInfoclass contains aCookieobject and information about the cookie that you can use for cookie management. To obtain aCookieInfoobject, call theconvertmethod of aSetCookieFieldobject in a response message.

Unlike browsers, MATLAB^®does not provide an automatic cookie store. You must save cookies on your own and send them back to servers as needed.

Class Attributes

Sealed true

For information on class attributes, seeClass Attributes.

Creation

Description

obj = matlab.net.http.CookieInfo(Name,Value)creates aCookieInfoobject with additional properties specified by one, or more name-value pair arguments.Nameis the property name andValueis the corresponding value. You can specify several name-value pair arguments in any order asName1,Value1,...,NameN,ValueN. Unspecified properties are set to their default values.

Use this constructor for testing.

Properties

expand all

`Cookie`—Cookie
`matlab.net.http.Cookie`object

Cookie, specified as amatlab.net.http.Cookieobject. Insert the Cookie into a request messageCookieFieldproperty.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Expires`—Cookie expiration time
`datetime`|NaT

Cookie expiration time, specified as adatetimeobject. If there is anExpiresattribute in the header field, then theExpiresproperty is set. If theExpiresattribute cannot be parsed, thenExpiresis NaT.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:datetime

`MaxAge`—Duration of cookie
integer|NaN

Duration of cookie, specified as an integer or NaN. If there is aMax-Ageattribute in the header field, then theMaxAgeproperty is set. If theMax-Ageattribute cannot be parsed, thenMaxAge是南。

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Domain`—Cookie domain
string

Cookie domain, specified as a string. If the Set-Cookie field does not specify aDomainattribute, then theDomainproperty is set to the request messageURI.Hostproperty andHostOnlyis set totrue.Domainnever begins with a period, as described inRFC 6265 — HTTP State Management Mechanism, Section 5.2.3.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:string

`Path`—Path attribute in Set-Cookie field
string

Path attribute in a Set-Cookie field, specified as a string. ThePathproperty is the value of thePathattribute in the Set-Cookie field. If the field does not contain a path attribute, then thePathproperty is set todefault-pathbased on the request messageURI.Pathproperty. For a description ofdefault-path, seeRFC 6265 — HTTP State Management Mechanism, Section 5.1.4. Paths and Path-Match.Pathalways begins with a slash (/) character.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:string

`Secure`—`Secure`属性的状态
`false`(default) |`true`

Secure属性的状态, where theSecureproperty is specified astrueorfalse. TheSecureproperty indicates that the Set-Cookie field contains aSecureattribute.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:logical

`HttpOnly`—`HttpOnly`属性的状态
`false`(default) |`true`

HttpOnly属性的状态, where theHttpOnlyproperty is specified astrueorfalse. TheHttpOnlyproperty indicates that the Set-Cookie field contains anHttpOnlyattribute.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:logical

`Extensions`—Values of`extension-av`属性
string

Values ofextension-av属性, specified as a string. The entire attribute is a single string, even if its syntax is of the formname=value.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:string

`HostOnly`—`Domain`属性的状态
`true`(default) |`false`

Domain属性的状态, where theHostOnlyproperty is specified astrueorfalse. If the Set-Cookie field contains aDomainattribute, thenHostOnlyis true.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:logical

`ExpirationTime`—Cookie expiration
`datetime`

Cookie expiration, specified as adatetimeobject.

If the Set-Cookie field contains either anExpiresor aMax-Ageattribute, thenExpirationTimeis set to the attribute.
If neither attribute appears, thenExpirationTimeis set todatetime('Inf')and the cookie is retained until the current session is over.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:datetime

`CreationTime`—Time cookie was created
`datetime`

Time the cookie was created, specified as adatetimeobject. TheSetCookieField.convert方法集CreationTimeto the current time.

If a newCookieInfoobject matches an existing one, then the new object replaces the old one. However, theCreationTimeproperty does not change. This behavior is specified inRFC 6265 — HTTP State Management Mechanism, Section 5.3 Storage Model, step 11.3. TheCookieInfoobjects match when theCookie.Name,CookieInfo.Domain, andCookieInfo.Path(if specified) properties are equal.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types:datetime

Methods

expand all

Public Methods

matlab.net.http.CookieInfo.collectFromLog Latest CookieInfo objects from HTTP response message history

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

`string`	Cookie info as string as it appears in a`SetCookieField`header field. This string might not exactly match the string that appeared in the field from which this`CookieInfo`was created, but it has the same semantic meaning.
`字符`	Cookie info as character vector

版本历史

Introduced in R2016b

matlab.net.http.CookieInfo class

Description

Class Attributes

Creation

Description

Properties

`Cookie`—Cookie
`matlab.net.http.Cookie`object

Attributes:

`Expires`—Cookie expiration time
`datetime`|NaT

Attributes:

`MaxAge`—Duration of cookie
integer|NaN

Attributes:

`Domain`—Cookie domain
string

Attributes:

`Path`—Path attribute in Set-Cookie field
string

Attributes:

`Secure`—`Secure`属性的状态
`false`(default) |`true`

Attributes:

`HttpOnly`—`HttpOnly`属性的状态
`false`(default) |`true`

Attributes:

`Extensions`—Values of`extension-av`属性
string

Attributes:

`HostOnly`—`Domain`属性的状态
`true`(default) |`false`

Attributes:

`ExpirationTime`—Cookie expiration
`datetime`

Attributes:

`CreationTime`—Time cookie was created
`datetime`

Attributes:

Methods

Public Methods

Specialized Operators and Functions

版本历史

See Also

External Websites

matlab.net.http.CookieInfo class

Description

Class Attributes

Creation

Description

Properties

Cookie—Cookiematlab.net.http.Cookieobject

Attributes:

Expires—Cookie expiration timedatetime|NaT

Attributes:

MaxAge—Duration of cookieinteger|NaN

Attributes:

Domain—Cookie domainstring

Attributes:

Path—Path attribute in Set-Cookie fieldstring

Attributes:

Secure—Secure属性的状态false(default) |true

Attributes:

HttpOnly—HttpOnly属性的状态false(default) |true

Attributes:

Extensions—Values ofextension-av属性string

Attributes:

HostOnly—Domain属性的状态true(default) |false

Attributes:

ExpirationTime—Cookie expirationdatetime

Attributes:

CreationTime—Time cookie was createddatetime

Attributes:

Methods

Public Methods

Specialized Operators and Functions

版本历史

See Also

External Websites

`Cookie`—Cookie
`matlab.net.http.Cookie`object

`Expires`—Cookie expiration time
`datetime`|NaT

`MaxAge`—Duration of cookie
integer|NaN

`Domain`—Cookie domain
string

`Path`—Path attribute in Set-Cookie field
string

`Secure`—`Secure`属性的状态
`false`(default) |`true`

`HttpOnly`—`HttpOnly`属性的状态
`false`(default) |`true`

`Extensions`—Values of`extension-av`属性
string

`HostOnly`—`Domain`属性的状态
`true`(default) |`false`

`ExpirationTime`—Cookie expiration
`datetime`

`CreationTime`—Time cookie was created
`datetime`