UnityWebRequest

class in UnityEngine.Networking

マニュアルに切り替える

説明

UnityWebRequest オブジェクトは Web サーバーとの通信に使われます。

UnityWebRequests は Web サーバとの HTTP 通信のフローを処理します。他のオブジェクト - 特に DownloadHandlerUploadHandler - はダウンロードとアップロードのデータそれぞれを管理します。

多くの一般的なユースケースのために、適切に設定された UnityWebRequest オブジェクトを返す便利な静的関数があります。 GetPostPutGetTexture

注意: UnityWebRequest オブジェクトのほとんどのプロパティーは、UnityWebRequest が Send メソッドを呼び出してリモートサーバーと通信を開始した後では変更することができません。

Static 変数

kHttpVerbCREATE"CREATE" 文字列。通常 HTTP CREATE リクエストの Verb として使用します。
kHttpVerbDELETE"DELETE" 文字列。通常、HTTP DELETE リクエストの Verb として使用します。
kHttpVerbGET"GET" 文字列。通常 HTTP GET リクエストの Verb として使用します。
kHttpVerbHEAD"HEAD" 文字列。通常 HTTP HEAD リクエストの Verb として使用します。
kHttpVerbPOST"POST" 文字列。通常 HTTP POST リクエストの Verb として使用します。
kHttpVerbPUT"PUT" 文字列。通常、HTTP PUT リクエストの Verb として使用します。

変数

chunkedTransferUnityWebRequest システムが HTTP/1.1 チャンク転送エンコード方法を採用すべきかどうかを示します。
disposeDownloadHandlerOnDisposeTrue の場合、この UnityWebRequest にアタッチされているいずれかの DownloadHandler は、UnityWebRequest.Dispose が呼び出されるとき、自動的に DownloadHandler.Dispose を呼び出します。
disposeUploadHandlerOnDisposeTrue の場合、UnityWebRequest.Dispose が呼び出されたとき、この UnityWebRequest にアタッチされているいずれの UploadHandler は自動的に UploadHandler.Dispose を呼び出します。
downloadedBytesシステムがリモートサーバーからダウンロードしたボディデータのバイト数を返します。
downloadHandlerこの UnityWebRequest でリモートサーバーから受信したデータを管理する DownloadHandler オブジェクトへの参照を保持します。
downloadProgressボディデータをサーバーからダウンロードの進行状況を示す 0.0 と 1.0 の間の浮動小数点値を返します。
errorHTTP リクエストまたはレスポンスを処理中に [UnityWebRequest]] オブジェクトによって発生したシステム エラーを説明する人間が判読できる文字列です。
isDone[UnityWebRequest]] はリモートサーバーとの通信が終了した後、true を返します。
isHttpErrorReturns true after this UnityWebRequest receives an HTTP response code indicating an error. (Read Only)
isModifiable UnityWebRequest の設定のプロパティーを変更することができる間、true が返されます。
isNetworkErrorこの UnityWebRequest システムエラーが発生した後は true を返します。
method GET や POST など、この UnityWebRequest によって使用される HTTP Verb を定義します。
redirectLimitこの UnityWebRequest が「リダイレクト制限を超えた」システムエラーで停止する前にリダイレクトの数を示します。
responseCode 200 、404 、500 などサーバーによって返される数値の HTTP レスポンスコード。
timeoutSets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed.
uploadedBytesシステムがリモートサーバーにアップロードしたボディデータのバイト数を返します。
uploadHandlerリモートサーバーにアップロードするデータを管理する UploadHandler オブジェクトへの参照を保持します。
uploadProgressボディデータをサーバーにアップロードする進行状況を示す 0.0 と 1.0 の間の浮動小数点値を返します。
url[UnityWebRequest]] と通信するターゲット URL を定義します。
useHttpContinueUnityWebRequest が送信リクエストヘッダーに Expect: 100-Continue を含めるかどうかを決定します(デフォルト: true )。

コンストラクタ

UnityWebRequestデフォルトのオプションと UnityWebRequest を作成し、DownloadHandler または UploadHandler をアタッチしません。デフォルトのメソッドは GET です。

Public 関数

Abort進行中の場合、UnityWebRequest をできるだけ早く停止させます。
Disposeこの UnityWebRequest が使用されておらず、いずれかのリソースをクリーンアップする必要がありますという信号として使われます。
GetRequestHeaderカスタムリクエストヘッダの値を取得します。
GetResponseHeader最新の HTTP レスポンスの受信からレスポンスヘッダーの値を取得します。
GetResponseHeaders最新の HTTP レスポンスの UnityWebRequest によって受信されたすべてのレスポンスヘッダーを含むディクショナリを取得します。
SetRequestHeaderHTTP リクエストヘッダーをカスタムの値にセットします。

Static 関数

DeleteHTTP DELETE のために設定した UnityWebRequest を作成します。
GenerateBoundaryマルチパートフォームバウンダリーとして使うためのランダムな 40 バイトの配列を生成します。
GetHTTP GET に対して設定した UnityWebRequest を作成します。
GetAssetBundleHTTP GET 経由で Unity Asset Bundle をダウンロードするために最適化された UnityWebRequest を作成します。
HeadHTTP HEAD リクエストを送信するように設定された UnityWebRequest を作成します。
PostUnityWebRequest は HTTP POST を介してサーバーにフォームデータを送信する設定を作成します。
PutRAW データを HTTP PUT 経由でリモートサーバーにアップロードするように設定した UnityWebRequest を作成します。
SerializeFormSectionsIMultipartFormSection オブジェクトのリストを RAW マルチパートフォームデータを含むバイト配列に変換します。
SerializeSimpleFormURL エンコードされた UTF-8 のキャラクタを含むバイト配列にストリングのディクショナリをシリアライズします。