Cookie - SuperApp - Alibaba Cloud ドキュメントセンター

このトピックでは、WVCookie の JavaScript API について説明します。HTML5 アプリまたはミニアプリを作成する際に、このトピックを参照できます。WVCookie の JavaScript API を使用して、Cookie の読み取りと書き込みを行うことができます。

重要

API 操作は失敗する可能性があります。これらの操作を呼び出すときは注意してください。

WVCookie.read

指定した URL からすべての Cookie を読み取ります。設定元のドメインから Cookie を読み取る場合は、JavaScript を使用することをお勧めします。異なるドメインによって設定された Cookie をあるドメインが読み取ることを許可する場合は、この API 操作を呼び出すことをお勧めします。

入力パラメーター

[string] url: Cookie を読み取る URL。

コールバックパラメーター

コールバックパラメーターは、コールバックメソッドを使用して渡されます。指定された URL から Cookie が取得された場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。

[object] value: 指定された URL から取得された Cookie。すべての Cookie はキーと値のペアとして保存されます。

var params = {
        // Cookie を読み取る URL。
        url: 'http:// 
xxx 
.com'
};
window.WindVane.call('WVCookie', 'read', params, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVCookie.write

Cookie を書き込みます。ドメインに Cookie を書き込む場合は、JavaScript を使用することをお勧めします。あるドメインに設定されている Cookie を別のドメインに書き込む場合は、この API 操作を呼び出すことをお勧めします。

入力パラメーター

[string]: 書き込む Cookie のキー。次のサンプルコードは参照用です。
[string] domain: Cookie を書き込むドメイン名。
[string] max-age: (オプション) Cookie の有効期間。
[string] path: (オプション) Cookie を書き込むパス。デフォルト値: '/'

説明

max-age および path を追加するのと同じ方法で、他の Cookie 属性を追加することもできます。この API 操作を呼び出すたびに設定できる Cookie は 1 つだけです。

コールバックパラメーター

コールバックパラメーターはありません。Cookie が正常に書き込まれた場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。

// 書き込む Cookie。次のサンプルコードでは、Cookie 名は cookieKey、値は cookieValue です。
var params = {
        cookieKey: 'cookieValue',
        domain: 'h5.m.taobao.com',
};
window.WindVane.call('WVCookie', 'write', params, function(e) {
        alert('success');
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});