matlab.net.http.field.SetCookieField Class

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

HTTP Set-Cookie header field

Description

A SetCookieField object appears in a response message created by the server. A message can have one or more Set-Cookie fields. To extract the Value property as a CookieInfo object, call the convert method.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Properties

Name — Header field name

'Set-Cookie'

Header field name, specified as 'Set-Cookie'.

Attributes:

GetAccess	public
SetAccess	public

Value — Header field value

string

Header field value, 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
convert	Returns CookieInfo object for each Set-Cookie field
convertLike	Convert header field value like another header field
parse	Parse header field value and return as strings
displaySubclasses	Display supported HeaderField subclasses

Specialized Operators and Functions

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

string	Array of header fields as string, as it appears in a message. Insert 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

Obtain Information from All Set-Cookie Fields in HTTP Message

r = matlab.net.http.RequestMessage();
uri = matlab.net.URI('http://httpbin.org/cookies/set?xxx=zzz&abc=def');
opts = matlab.net.http.HTTPOptions('MaxRedirects',0);
resp = r.send(uri,opts);
setCookieFields = resp.getFields('Set-Cookie');
if ~isempty(setCookieFields)
   cookieInfos = setCookieFields.convert(uri);
   r = r.addFields(matlab.net.http.field.CookieField([cookieInfos.Cookie]));
end
resp = r.send('http://httpbin.org/cookies');
disp(resp.Body.Data.cookies)

    abc: 'def'
    xxx: 'zzz'

Version History

Introduced in R2016b