ZEPETO.Multiplay.HttpService

11 分

型	説明
HttpContentType	HTTP の Content-Type を指定する定数の列挙型。
HttpBodyType	HTTP ボディの内容の型エイリアス。プレーンテキストまたはキーと値のオブジェクトのいずれかを指定できます。
HttpHeader	HTTP ヘッダーの型エイリアス。キーと値のオブジェクトを表します。
HttpErrorType	HTTP リクエストが失敗した理由を指定する定数の列挙型。
HttpError	HTTP リクエスト中に発生したエラーを表します。
HttpResponse	HTTP レスポンスを表します。
HttpService	HttpService は、外部の Web サービスと HTTP 接続を確立してリクエストを行うための API を提供します。 - HTTPS プロトコルを使用してください。HTTP は開発環境でのみサポートされます。 - リクエストはポート 80 と 443 に限定されます。 - リクエストボディとレスポンスボディの最大サイズは 16KB です。 - リクエストが過剰になると World サービスに制限がかかる可能性があるため、1 分あたりのリクエスト数は 500 未満に抑えてください。 - 外部の Web サービスが 5 秒以内に応答しない場合、リクエストは失敗します。 - リクエストの失敗を防ぐため、レスポンスヘッダーの Content-Type が HttpContentType 列挙型で定義された値と一致していることを確認してください。 - Web リクエストはさまざまな理由で失敗する可能性があるため、防御的にコーディングすることをおすすめします。

HttpContentType

enum

HTTP の Content-Type を指定する定数の列挙型。

名前	値	説明
ApplicationJson	"application/json"	application/json コンテンツタイプを表します。
ApplicationXml	"application/xml"	application/xml コンテンツタイプを表します。
ApplicationUrlEncoded	"application/x-www-form-urlencoded"	application/x-www-form-urlencoded コンテンツタイプを表します。
TextPlain	"text/plain"	text/plain コンテンツタイプを表します。
TextXml	"text/xml"	text/xml コンテンツタイプを表します。

HttpBodyType

delegate

HTTP ボディの内容の型エイリアス。プレーンテキストまたはキーと値のオブジェクトのいずれかを指定できます。

string | { [key: string]: any; }

HttpHeader

delegate

HTTP ヘッダーの型エイリアス。キーと値のオブジェクトを表します。

{ [key: string]: string | number; }

HttpErrorType

enum

HTTP リクエストが失敗した理由を指定する定数の列挙型。

名前	値	説明
ERR_ACCESS_DENIED	"ERR_ACCESS_DENIED"	エラー: アクセスが拒否されました。
ERR_LENGTH_REQUIRED	"ERR_LENGTH_REQUIRED"	エラー: 長さの指定が必要です。

HttpError

interface · extends Error

HTTP リクエスト中に発生したエラーを表します。

プロパティ

名前	型	説明
message	string	エラーメッセージ。
code	string	HttpErrorType 列挙型の値として定義されたエラーコード。

HttpResponse

interface

HTTP レスポンスを表します。

プロパティ

名前	型	説明
statusCode	number	レスポンスのステータスコード。通常、200 はリクエストの成功を示します。
statusText	string	ステータスコードに対応するステータスメッセージ。通常、「OK」はリクエストの成功を示します。
response	string	HTTP レスポンスのボディ。レスポンスの Content-Type によって形式が異なる場合があります。受信した Content-Type に応じた適切なパーサーを使用することをおすすめします。

HttpService

interface

HttpService は、外部の Web サービスと HTTP 接続を確立してリクエストを行うための API を提供します。

HTTPS プロトコルを使用してください。HTTP は開発環境でのみサポートされます。

リクエストはポート 80 と 443 に限定されます。

リクエストボディとレスポンスボディの最大サイズは 16KB です。

リクエストが過剰になると World サービスに制限がかかる可能性があるため、1 分あたりのリクエスト数は 500 未満に抑えてください。

外部の Web サービスが 5 秒以内に応答しない場合、リクエストは失敗します。

リクエストの失敗を防ぐため、レスポンスヘッダーの Content-Type が HttpContentType 列挙型で定義された値と一致していることを確認してください。

Web リクエストはさまざまな理由で失敗する可能性があるため、防御的にコーディングすることをおすすめします。

メソッド

getAsync

getAsync(url: string, headers?: HttpHeader) → Promise<HttpResponse>

HTTP GET リクエストを非同期で実行します。HttpError をスローします。

パラメーター	型	説明
url	string	リクエストの送信先となる Web アドレス。
headers (省略可能)	HttpHeader	HTTP リクエストヘッダー。(省略可能)

戻り値: Promise<HttpResponse> — 処理の完了時に HttpResponse オブジェクトとともに解決される Promise。

postAsync

postAsync(url: string, body: HttpBodyType, headers?: HttpHeader) → Promise<HttpResponse>

HTTP POST リクエストを非同期で実行します。HttpError をスローします。

パラメーター	型	説明
url	string	リクエストの送信先となる Web アドレス。
body	HttpBodyType	リクエストボディの内容。
headers (省略可能)	HttpHeader	HTTP リクエストヘッダー。(省略可能)

戻り値: Promise<HttpResponse> — 処理の完了時に HttpResponse オブジェクトとともに解決される Promise。

postAsync

postAsync(url: string, body: HttpBodyType, httpContentType: HttpContentType, headers?: HttpHeader) → Promise<HttpResponse>

HTTP POST リクエストを非同期で実行します。HttpError をスローします。このシグネチャを使用する場合、headers に「Content-Type」を追加しても、httpContentType で指定した値によって上書きされます。

パラメーター	型	説明
url	string	リクエストの送信先となる Web アドレス。
body	HttpBodyType	リクエストボディの内容。
httpContentType	HttpContentType	リクエストの Content-Type ヘッダーを指定します。
headers (省略可能)	HttpHeader	HTTP リクエストヘッダー。(省略可能)

戻り値: Promise<HttpResponse> — 処理の完了時に HttpResponse オブジェクトとともに解決される Promise。