matlab.net.http.field.CookieField class

Package: matlab.net.http.field
Superclasses: matlab.net.http.HeaderField

HTTP Cookie header field

Description

If there are cookies in a Set-Cookie field, then you can send them to a server by including a CookieField object in your request message. For more information, see RFC 6265 HTTP State Management Mechanism on the Internet Engineering Task Force (IETF^®) website.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

Description

obj = matlab.net.http.field.CookieField(value) creates a Cookie header field with the Value property set to value.

Properties

Name — Header field name

'Cookie'

Header field name, specified as 'Cookie'.

Attributes:

GetAccess	public
SetAccess	public

Value — Cookie

string

Cookie, specified as a string.

Attributes:

GetAccess	public
SetAccess	public
Dependent	true

Methods

Public Methods

addFields	Add fields to HeaderField array
removeFields	Remove fields from header field array
changeFields	Change existing values in HeaderField array
replaceFields	Change values in or add fields to array of HeaderFields
getFields	Return header fields matching name or class
eq	Compare two HeaderField arrays
convertLike	Convert header field value like another header field
parse	Parse header field value and return as strings
displaySubclasses	Display supported HeaderField subclasses

Specialized for Subclass

convert

Vector of Cookie objects in CookieField

Specialized Operators and Functions

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

isequal	true if two header field arrays are the same size and corresponding elements are equal, as described by eq method
string	Array of header fields as string, as it appears in a message. Inserts newline characters between fields but not at the end of all fields.
char	Array of header fields as character vector, as described by string method

Examples

Send All Received HTTP Cookies Back to Server

This example sends all cookies to a server. In practice, you would send only unexpired cookies.

If the initial exchange involves multiple messages for authentication and redirection, you might want to obtain the CookieInfo object from the history containing all these messages. For more information, see CookieInfo.collectFromLog.

r = matlab.net.http.RequestMessage;
resp = send(r,'https://www.mathworks.com');
setCookieFields = resp.getFields('Set-Cookie');
if ~isempty(setCookieFields)
   % fetch all CookieInfos from Set-Cookie fields and add to request
   cookieInfos = setCookieFields.convert;
   r = r.addFields(matlab.net.http.field.CookieField([cookieInfos.Cookie]));
end
resp = r.send('https://www.mathworks.com');

Version History

Introduced in R2016b