matlab.net.http.field.LocationField Class

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

HTTP Location header field

Description

A LocationField object contains the message uniform resource identifier (URI). The server adds a Location field to a response message to tell you to redirect messages to another URI. The meaning of this field depends on the status code of the response.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

Description

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

Properties

Name — Header field name

'Location'

Header field name, specified as 'Location'.

Attributes:

GetAccess	public
SetAccess	public

Value — URI

matlab.net.URI object | string

URI, specified as a matlab.net.URI object or a string acceptable to the URI constructor.

Attributes:

GetAccess	public
SetAccess	public
Dependent	true

Methods

Public Methods

convertLike	Convert header field value like another header field
parse	Parse header field value and return as strings
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
displaySubclasses	Display supported HeaderField subclasses

Specialized for Subclass

convert

Return Value property of LocationField as matlab.net.URI object

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 Message URI

This example shows how to read a message URI.

import matlab.net.*;
import matlab.net.http.*;
httpUrl = 'http://requestserver.mathworks.com';
uri = URI(strcat(httpUrl, '/movedPermanently'));
options = HTTPOptions('MaxRedirects', 0); % Disable redirects
req = RequestMessage('GET');
response = req.send(uri, options);
locationField = response.getFields("Location");
disp(locationField)

  LocationField with properties:

     Name: "Location"
    Value: "http://requestserver.mathworks.com/assets/computerVision.jpg"

Version History

Introduced in R2016b