HttpFormFilesParam (クラス)
public HttpFormFilesParam {inherits HttpFormParam}
インポート元： CURL.GUI.STANDARD. package 内で定義されています CURL.IO.HTTP.

1 つまたは複数のファイルからのデータを含む HTTP フォーム パラメータを保持するクラス。このクラスのインスタンスを HttpFormData に追加します。


コンストラクタ
default:指定された名前と 1 つのファイルを値として持つ HttpFormFilesParam を作成します。
コンストラクタ public {HttpFormFilesParam.default
name:String,
file-name:#String,
file-data:{Array-of byte},
file-content-type:#String = "application/octet-stream",
file-content-transfer-encoding:#String = "binary",
multipart-boundary:#String = null
}

プロパティ
file-content-transfer-encodings:このフォーム パラメータにおける各ファイルの content-transfer-encodings のリスト。null の場合、このファイルには content-transfer-encoding がないことを意味します。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。
フィールド public constant HttpFormFilesParam.file-content-transfer-encodings:{Array-of #String}
file-content-types:このフォーム パラメータにおける各ファイルの content-types のリスト。null の場合、このファイルには content-type がないことを意味します。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。
フィールド public constant HttpFormFilesParam.file-content-types:{Array-of #String}
file-data:このフォーム パラメータにおける各ファイルのデータのリスト。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。
フィールド public constant HttpFormFilesParam.file-data:{Array-of {Array-of byte}}
file-names:このフォーム パラメータにおける各ファイル名のリスト。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。
フィールド public constant HttpFormFilesParam.file-names:{Array-of #String}
multipart-boundary:HttpFormFilesParam.default の multipart-boundary パラメータを参照してください。
アクセサ public HttpFormFilesParam.multipart-boundary:String
セッター public HttpFormFilesParam.multipart-boundary:#String
プロパティ 継承 HttpFormParam: name

メソッド
append-file-value:このフォーム パラメータの値に別のファイルを追加します。
public {HttpFormFilesParam.append-file-value
file-name:#String,
file-data:{Array-of byte},
file-content-type:#String = "application/octet-stream",
file-content-transfer-encoding:#String = "binary"
}:void
request-data-multipart-bytes:HttpFormParam のデータを "multipart/form-data" (つまり HttpFormData.multipart-mime-type) のスタイルのエンコーディングで、Array-of byte として返します。これには適切な MIME ヘッダーも含まれます。
public {HttpFormFilesParam.request-data-multipart-bytes
default-character-encoding:CharEncoding = CharEncoding.ascii
}:{Array-of byte}
request-data-urlencoded-bytes:この HttpFormParam のデータを "application/x-www-form-urlencoded" (つまり HttpFormData.urlencoded-mime-type) スタイルのエンコーディングで、Array-of byte として返します。
public {HttpFormFilesParam.request-data-urlencoded-bytes
default-character-encoding:CharEncoding = CharEncoding.ascii
}:{Array-of byte}
request-data-urlencoded-string:この HttpFormParam のデータを "application/x-www-form-urlencoded" (つまり HttpFormData.urlencoded-mime-type) スタイルのエンコーディングで、String として返します。
public {HttpFormFilesParam.request-data-urlencoded-string
default-character-encoding:CharEncoding = CharEncoding.ascii
}:String
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {HttpFormFilesParam.default
name:String,
file-name:#String,
file-data:{Array-of byte},
file-content-type:#String = "application/octet-stream",
file-content-transfer-encoding:#String = "binary",
multipart-boundary:#String = null
}

指定された名前と 1 つのファイルを値として持つ HttpFormFilesParam を作成します。

name: フォーム パラメータの名前。ASCII 文字だけを指定できます。ASCII 以外の文字を使用する場合、呼び出し側は RFC 2045 に従いこの文字列のプリエンコードが必要になります。
content-type: HttpFormData.multipart-mime-type 形式の場合に使用する "Content-Type" ヘッダーの値。null は、"Content-Type" ヘッダーがないことを意味します。
file-name: HttpFormFilesParam.append-file-value の file-name パラメータを参照してください。
file-data: HttpFormFilesParam.append-file-value の file-data パラメータを参照してください。
file-content-type: HttpFormFilesParam.append-file-value の file-content-type パラメータを参照してください。
file-content-transfer-encoding: HttpFormFilesParam.append-file-value の file-content-transfer-encoding パラメータを参照してください。
multipart-boundary: 複数のファイルがある場合にファイルを区切るために使用する String。このパラメータが null の場合、HttpFormData.request-data が最初に呼び出されたときに、値が無作為に生成されます。この区切りの文字列は、送信するデータには存在しない一意の文字列であることが必要です。


プロパティ詳細
file-content-transfer-encodings (フィールド)
public constant HttpFormFilesParam.file-content-transfer-encodings:{Array-of #String}

このフォーム パラメータにおける各ファイルの content-transfer-encodings のリスト。null の場合、このファイルには content-transfer-encoding がないことを意味します。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。


file-content-types (フィールド)
public constant HttpFormFilesParam.file-content-types:{Array-of #String}

このフォーム パラメータにおける各ファイルの content-types のリスト。null の場合、このファイルには content-type がないことを意味します。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。


file-data (フィールド)
public constant HttpFormFilesParam.file-data:{Array-of {Array-of byte}}

このフォーム パラメータにおける各ファイルのデータのリスト。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。


file-names (フィールド)
public constant HttpFormFilesParam.file-names:{Array-of #String}

このフォーム パラメータにおける各ファイル名のリスト。各要素は、他の file-* フィールド内で同じインデックスを持つ要素に対応しています。


multipart-boundary (アクセサ)
アクセサ public HttpFormFilesParam.multipart-boundary:String
セッター public HttpFormFilesParam.multipart-boundary:#String

HttpFormFilesParam.default の multipart-boundary パラメータを参照してください。





メソッド詳細
append-file-value (メソッド)
public {HttpFormFilesParam.append-file-value
file-name:#String,
file-data:{Array-of byte},
file-content-type:#String = "application/octet-stream",
file-content-transfer-encoding:#String = "binary"
}:void

このフォーム パラメータの値に別のファイルを追加します。

file-name: 追加するファイルの名前。ASCII 文字だけを使用できます。ASCII 以外の文字を使用する場合は、RFC 2045 に従いこの文字列のプリエンコードが必要になります。空の文字列または null の場合、ファイル名がないことを意味します。
file-data: 追加するファイルのデータ。
file-content-type: 追加するファイルで使用する "Content-Type" ヘッダーの値。null の場合、"Content-Type" ヘッダーがないことを意味します。
file-content-transfer-encoding: 追加するファイルで使用する "Content-Transfer-Encoding" ヘッダーの値。null の場合、"Content-Transfer-Encoding" ヘッダーがないことを意味します。

request-data-multipart-bytes (メソッド)
public {HttpFormFilesParam.request-data-multipart-bytes
default-character-encoding:CharEncoding = CharEncoding.ascii
}:{Array-of byte}

HttpFormParam のデータを "multipart/form-data" (つまり HttpFormData.multipart-mime-type) のスタイルのエンコーディングで、Array-of byte として返します。これには適切な MIME ヘッダーも含まれます。

default-character-encoding: MIME ヘッダーの文字列をエンコードするのに使用する CharEncoding。

オーバーライド

非抽象サブクラスによる実装でオーバーライドされます。

注意事項

HttpFormData.mime-type が HttpFormData.multipart-mime-type の場合に HttpFormData.request-data で使用されます。

request-data-urlencoded-bytes (メソッド)
public {HttpFormFilesParam.request-data-urlencoded-bytes
default-character-encoding:CharEncoding = CharEncoding.ascii
}:{Array-of byte}

この HttpFormParam のデータを "application/x-www-form-urlencoded" (つまり HttpFormData.urlencoded-mime-type) スタイルのエンコーディングで、Array-of byte として返します。

default-character-encoding: 必要に応じて危険な文字を % エスケープ シーケンスに変換した後で、文字列をバイト列にエンコードするのに使用する CharEncoding。サブクラスによっては、これを '=' のエンコードだけに使用し、名前と値には自身の文字エンコーディングを使用します。(ここでの危険な文字とは一般に '='、'&'、' '、' '、' '、および ' ' だけですが、他もエンコード対象になることがあります。)

オーバーライド

非抽象サブクラスによる実装でオーバーライドされます。

注意事項

HttpFormData.mime-type が HttpFormData.urlencoded-mime-type の場合に HttpFormData.request-data で使用されます。

request-data-urlencoded-string (メソッド)
public {HttpFormFilesParam.request-data-urlencoded-string
default-character-encoding:CharEncoding = CharEncoding.ascii
}:String

この HttpFormParam のデータを "application/x-www-form-urlencoded" (つまり HttpFormData.urlencoded-mime-type) スタイルのエンコーディングで、String として返します。

default-character-encoding: 必要に応じてバイト列を % エスケープ シーケンスに変換した後で、実装でコードが必要なバイト データをエンコードする際に使用する CharEncoding。サブクラスによっては、これを '=' のエンコードだけに使用し、名前と値には自身の文字エンコーディングを使用します。(ここでいう危険な文字としては、ASCII の句読点と制御文字のほとんど、およびすべての非 ASCII 文字が考えられます。）

オーバーライド

既定の実装 (HttpFormParam.request-data-urlencoded-bytes を呼び出し、その結果をデコードして String に格納します) が不適当な場合にオーバーライドします。