addFields

クラス: matlab.net.http.Message
名前空間: matlab.net.http

メッセージ ヘッダーへのフィールドの追加

このページをすべて展開する

構文

msg = addFields(msg,fields)
msg = addFields(msg,fName,fValue)
msg = addFields(msg,fName1,fValue1,...,fNameN,fValueN)
msg = addFields(msg,index,___)

説明

msg = addFields(msg,fields) は fields を各メッセージのヘッダーの最後に追加し、更新されたメッセージを返します。

addFields は重複フィールドがあるかどうかをチェックしませんが、RequestMessage の send メソッドおよび complete メソッドは不適切な重複を拒否することがあります。

send メソッドまたは complete メソッドが特定のヘッダー フィールドを自動的に追加しないようにするには、そのフィールドについて、空 ([]) の Value プロパティを指定して addFields を呼び出します。

例

msg = addFields(msg,fName,fValue) は、名前 fName と値 fValue をもつフィールドを追加します。

msg = addFields(msg,fName1,fValue1,...,fNameN,fValueN) は、fName と fValue のペアの引数で指定されるフィールドを、指定された順序で追加します。

例

msg = addFields(msg,index,___) は index の位置にフィールドを挿入し、前述の構文に任意の入力引数を含めることができます。

例

入力引数

すべて展開する

メッセージ。matlab.net.http.Message オブジェクトとして指定します。

追加するフィールド。1 つ以上の matlab.net.http.HeaderField オブジェクトのベクトルまたはコンマ区切りリストとして指定します。

例: matlab.net.http.HeaderField('Accept','text/plain')

ヘッダー フィールド名。string として指定します。

例: 'Accept'

ヘッダー フィールド値。string または fName に有効なタイプとして指定します。フィールドに既定値を使用するには、fValue を '' に設定します。最後の値がない場合は、[] と指定するのと同じになります。

例: 'text/plain'

メッセージ ヘッダー内の位置。整数として指定します。index がヘッダーの長さよりも大きいか、または index が 0 の場合、メソッドは最後にフィールドを追加します。index が負数の場合、メソッドはヘッダーの最後からカウントします。

例: -1 は最後のフィールドの前に fields を挿入します。

例

すべて展開する

ライブ スクリプトを開く

値 'text/plain' をもつ Accept ヘッダー フィールドを作成し、既定の要求メッセージに追加します。 

field = matlab.net.http.HeaderField('Accept','text/plain');
m = matlab.net.http.RequestMessage('get');
msg = addFields(m,field);
show(msg)
GET
Accept: text/plain
ライブ スクリプトを開く

2 つのヘッダー フィールドを要求メッセージに追加します。 

m = matlab.net.http.RequestMessage('get');
msg = addFields(m,'Accept','text/plain','Cache-Control','no-store, no-cache');
show(msg)
GET
Accept: text/plain
Cache-Control: no-store, no-cache
ライブ スクリプトを開く

2 つのヘッダー フィールドを含む要求メッセージを作成します。 

m = matlab.net.http.RequestMessage('get');
msg = addFields(m,'Accept','text/plain','Cache-Control','no-store, no-cache');

メッセージの最後のヘッダー フィールドの前に、Content-Type ヘッダー フィールドを挿入します。 

f = matlab.net.http.HeaderField('Content-Type','text/plain');
msg = addFields(msg,-1,f);
show(msg)
GET
Accept: text/plain
Content-Type: text/plain
Cache-Control: no-store, no-cache

バージョン履歴

R2016b で導入

参考

|