Namespace: h5

h5

h5オブジェクト
Source:

Namespaces

api
async
core
env
log
mixin
res
scene
settings
u
ui
validation

Methods

(static) ajax(var_args) → {JqXHRWrapper}

HTTP通信を行います。

基本的な使い方は、jQuery.ajax()と同じです。戻り値はjqXHRをラップした JqXHRWrapperクラスです。

jQuery.ajax()と異なる点は共通のエラーハンドラが定義できることと、リトライオプションを指定できることです。


共通のエラーハンドラ

h5.settings.commonFailHandlerに関数が設定されている場合、 エラーコールバックが登録されないままajaxが失敗すると、h5.settings.commonFailHandlerに設定した関数が呼ばれます。


リトライオプション

h5.settings.ajaxでリトライをする設定がしてあれば、リトライを行います(デフォルトはリトライを行わない)。
また、引数からもリトライの設定を指定することができ、h5.settings.ajaxの設定よりも優先します。

h5.ajax({
	url: 'hoge',
	cache: false		// jQuery.ajaxのオプション
	retryCount: 3,		// h5.ajaxで追加しているオプション。リトライ回数。
	retryInterval: 200	// h5.ajaxで追加しているオプション。リトライ間のインターバル。
	retryFilter: function()		// h5.ajaxで追加しているオプション。リトライ毎に実行される関数。
});

リトライ回数の設定してある場合は、リトライ途中で通信に成功した場合はdoneコールバックが、 リトライ回数回リトライしても失敗した場合はfailコールバックが呼ばれます。

同期(async:false)で呼んだ時は、retryIntervalの値に関わらず即座に同期でリトライを行います。ajax通信結果は同期で返ってきます。

Parameters:
Name Type Description
var_args Any jQuery.ajaxに渡す引数
Returns:
jqXHRWrapperオブジェクト
Type
JqXHRWrapper
Source: