removeFields

Class: matlab.net.http.Message
Namespace: matlab.net.http

Remove fields from message header

expand all in page

Syntax

msg = removeFields(msg,ids)

Description

msg = removeFields(msg,ids) removes all header fields matching ids and returns the updated message.

example

Input Arguments

expand all

Message, specified as a matlab.net.http.Message object.

Names to match, specified as one of the following.

  • String vector, character vector, cell array of character vectors, or comma-separated list of strings or character vectors containing the names of the fields to remove. Names are not case-sensitive.

  • Vector or comma-separated list of one or more HeaderField objects whose Name properties are used to determine which fields to remove. Names are not case-sensitive. Header field values are ignored.

  • Vector or comma-separated list of matlab.metadata.Class objects that are subclasses of HeaderField.

    The removeFields method searches for names that match names supported by the specified classes, regardless of the class. If a subclass does not have a specific set of supported names, all header fields of that subclass are matched regardless of their names. Call the HeaderField.displaySubclasses method to see supported names.

Example: getFields(response,'Date','Content-Type')

Examples

expand all

Open Live Script

Create a request message with two header fields, Cache-Control and Content-Type, and display the message. 

import matlab.net.http.HeaderField

m = matlab.net.http.RequestMessage('get');
f1 = HeaderField('Cache-Control','no-store, no-cache');
f2 = HeaderField('Content-Type','text/html;charset=utf-8');
m = addFields(m,f1,f2);
show(m)
GET
Cache-Control: no-store, no-cache
Content-Type: text/html;charset=utf-8

Remove the Cache-Control field and display the updated message.

msg = removeFields(m,'Cache-Control');
show(msg)
GET
Content-Type: text/html;charset=utf-8
Open Live Script

The MediaRangeField class has two subclasses, AcceptField and ContentTypeField. An ID that specifies the MediaRangeField class matches all fields of class MediaRangeField, AcceptField, and ContentTypeField, plus any fields with the Name property 'Accept' or 'Content-Type'.

Create message m with a ContentTypeField header field.

m = matlab.net.http.RequestMessage('get');
f = matlab.net.http.HeaderField('Content-Type','text/html;charset=utf-8');
m = addFields(m,f);

Remove all header fields that are subclasses of the MediaRangeField class and display the updated message.

id = ?matlab.net.http.field.MediaRangeField;
msg = removeFields(m,id);
show(msg)
GET

Version History

Introduced in R2016b

See Also

|