Prototype-ajax-options

提供:Dev Guides
移動先:案内検索

プロトタイプ-AJAXオプション

これは、_options_とコールバックの共通セットを共有する_Ajax_名前空間です。

コールバックは、リクエストのライフサイクルのさまざまな時点で呼び出され、常に同じ引数リストを備えています。 それらは、他のオプションとともに要求者に直接渡されます。

一般的なオプション

Option Description
asynchronous

Default value is true.

XMLHttpRequestが非同期で使用されるかどうかを決定します。

contentType

Default value is application/x-www-form-urlencoded.

リクエストのContent-Typeヘッダー。

encoding

Default value is UTF-8.

リクエストのContent-Typeヘッダー。

method

Default value is post.

要求に使用するHTTPメソッド。

parameters

'Default value is '.

「get」メソッドのURLまたは他のメソッドのリクエスト本文にエンコードされるリクエストのパラメーター。 これは、URLエンコードされた文字列として、またはパラメーターを表すプロパティを持つハッシュ互換オブジェクトとして提供できます。

postBody

Default value is None.

「post」メソッドのリクエスト本文の特定のコンテンツ。 指定されていない場合は、代わりにパラメータオプションの内容が使用されます。

requestHeaders

See description below.

リクエストヘッダーは2つの形式で渡すことができます-

  • ヘッダーを表すプロパティを持つ*オブジェクト*として。
  • 偶数インデックス(0、2 …​)要素がヘッダー名であり、奇数インデックス(1、3 …​)要素が値である array として。

プロトタイプは自動的にデフォルトヘッダーのセットを提供します。このオプションは、このオプションをオーバーライドおよび拡張できます-

  • X-Requested-With は_'XMLHttpRequest'_に設定されます。
  • X-Prototype-Version は、Prototypeの現在のバージョンを提供します(例: 1.5.0)。
  • Accept のデフォルトは_'text/javascript、text/html、application/xml、text/xml、 / '_
  • Content-type は、_contentType_および_encoding_オプションに基づいて構築されます。
evalJS

Default value is true.

サーバーによって返されるコンテンツタイプが次のいずれかである場合、_Ajax.Response#responseText_のコンテンツを自動的に評価します-

アプリケーション/ecmascript、

application/javascript、

application/x-ecmascript、

application/x-javascript、

テキスト/ecmascript、

text/javascript、

text/x-ecmascript、または

text/x-javascriptおよびリクエストは、http://en.wikipedia.org/wiki/Same_origin_policy [SOP](Simple Origin Policy)に従います。 評価を強制する必要がある場合は、「force」を渡します。 それを完全に防ぐには、falseを渡します。

evalJSON

Default value is true.

サーバーによって返されるコンテンツタイプが_application/json_に設定されている場合、_Ajax.Response#responseText_のコンテンツを自動的に評価し、_Ajax.Response#responseJSON_にデータを設定します。

要求がSOPに従っていない場合、コンテンツは評価の前にサニタイズされます。 評価を強制する必要がある場合は、「force」を渡します。 それを完全に防ぐには、falseを渡します。

sanitizeJSON

false for local requests, true otherwise.

_Ajax.Response#responseText_のコンテンツを評価する前にサニタイズします。

一般的なコールバック

S.No. Callback & Description
1.

onCreate

Ajax.Requestオブジェクトが初期化されると開始します。 これは、パラメーターとURLが処理された後、XHRオブジェクトのメソッドを最初に使用する前です。

2.

onComplete

リクエストのライフサイクルの最後にトリガーされ、リクエストが完了すると、ステータス固有のコールバックが呼び出され、可能な自動動作が処理されました。

3.

onException

XHRエラーが発生するたびにトリガーされます。 カスタム署名があります:最初の引数はリクエスターです(つまり、 Ajax.Requestインスタンス)、2番目は例外オブジェクトです。

4.

onFailure

要求が完了し、そのステータスコードが存在するが、2xyファミリーにない場合に呼び出されます。 コード固有のコールバックが定義されている場合、これはスキップされ、onCompleteの前に発生します。

5.

onInteractive

_保証されていません_が、リクエスターが応答の一部を受信すると必ずトリガーされます(ただし、最後の部分は受信されません)。

6.

onLoaded

_保証されていません_が、基礎となるXHRオブジェクトがセットアップされ、接続が開かれ、実際のリクエストを送信する準備ができたらトリガーされます。

7.

onLoading

_保証されていません_が、基礎となるXHRオブジェクトがセットアップされ、その接続が開かれたときにトリガーされます。

8.

onSuccess

要求が完了し、そのステータスコードが未定義であるか、2xyファミリーに属している場合に呼び出されます。 これは、コード固有のコールバックが定義されている場合はスキップされ、_onComplete_の前に発生します

9.

onUninitialized

_保証されていません_が、XHRオブジェクトが作成されたときに呼び出されます。

10.

onXYZ

XYZは、応答のHTTPステータスコードです。 応答が完了したときに呼び出され、ステータスコードはコールバック名で使用したものとまったく同じです。 onSuccess/onFailureの実行を防止します。 onCompleteの前に発生します。

レスポンダーコールバック

S.No. Callback & Description
1.

onCreate

Ajax名前空間のリクエスターオブジェクトが作成され、パラメーターが調整された後、XHR接続が開かれる前にトリガーされます。 これは、リクエスター_object_と基礎となる_XHRオブジェクトの2つの引数を取ります。

2.

onComplete

リクエストのライフサイクルの最後にトリガーされ、リクエストが完了すると、ステータス固有のコールバックが呼び出され、可能な自動動作が処理されました。

3.

onException

XHRエラーが発生するたびにトリガーされます。 カスタム署名があります:最初の引数はリクエスターです(つまり、 Ajax.Requestインスタンス)、2番目は例外オブジェクトです。

4.

onInteractive

_保証されていませんが、リクエスターが応答の一部(ただし、最終部分ではない)を受信するたびにリガーされます。

5.

onLoaded

_保証されていません_が、基礎となるXHRオブジェクトがセットアップされ、接続が開かれ、実際のリクエストを送信する準備ができたらトリガーされます。

6.

onLoading

_保証されていません_が、基礎となるXHRオブジェクトがセットアップされ、その接続が開かれたときにトリガーされます。

7.

onUninitialized

_保証されていません_が、XHRオブジェクトが作成されたときに呼び出されます。