本文介紹跨域類WVCookie相關的JSAPI,供您建立H5端應用或者小程式時參考。跨域類WVCookie的JSAPI提供寫入、讀取Cookie的相關能力。
重要
該API不確保執行成功,使用請謹慎。
WVCookie.read
讀取指定URL的所有Cookie。一般建議使用JS來讀取Cookie,只有需要讀取其它網域名稱Cookie時才使用此方法。
輸入參數
[
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。總是建議使用JS來寫入Cookie,只有需要向其它網域名稱寫入Cookie時才使用此方法。
輸入參數
[
string]要寫入的Cookie 的鍵,可以參考下面的樣本。[
string]domain:要寫入的Cookie的域。[
string]max-age:(可選)要寫入的Cookie的max-age。[
string]path:(可選)要寫入的Cookie的path,預設為'/'。
說明
其它Cookie屬性也可以按照max:age和path的方式額外添加進來,一次只能設定一條Cookie,設定多條的話請多次調用該介面。
回調參數
無回調參數,如果成功寫入指定Cookie,則進入success回調,否則進入failure回調。
// 要寫入的 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));
});