matlab.net.http.field.DateField class

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

HTTP Date header field

Description

A DateField object represents an HTTP Date header field. A Date field is an optional field that represents the date and time a request or a response message was originally sent. If you do not specify a Date field in a request message, then MATLAB^® inserts one when you send it.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

Description

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

obj = matlab.net.http.field.DateField sets the field value to the current date and time.

Properties

Name — Header field name

'Date'

Header field name, specified as 'Date'.

Attributes:

GetAccess	public
SetAccess	public

Value — Date and time

current date and time (default) | datetime | string

Date and time, specified as a datetime object or a string in a valid HTTP date format. The default is the current date and time. Value must not be in the future. If the time zone is missing, then the local time zone is assumed. The datetime Format property is ignored.

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

Value property of DateField as array of MATLAB datetime objects

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

Display Date Field

This example shows how to read the date field in a message.

import matlab.net.*;
import matlab.net.http.*;
import matlab.net.http.field.*;

httpsUrl = 'https://requestserver.mathworks.com';
uri = URI(strcat(httpsUrl, '/assets/computerVision.jpg'));
headers = DateField(datetime("today"));
req = RequestMessage('GET', headers);
[~, completedRequest, ~] = req.send(uri);
dateField = completedRequest.getFields("Date");
disp(dateField)

  DateField with properties:

     Name: "Date"
    Value: "Wed, 28 Apr 2021 04:00:00 GMT"

Version History

Introduced in R2016b