Electron session 模块
|
session 模块可以用来创建一个新的 Session 对象. 你也可以通过使用 webContents 的属性 session 来使用一个已有页面的 session ，webContents是BrowserWindow 的属性. const BrowserWindow = require('electron').BrowserWindow;var win = new BrowserWindow({ width: 800, height: 600 });
win.loadURL("http://github.com");var ses = win.webContents.session;方法session 模块有如下方法: session.fromPartition(partition)
从字符串 partition 返回一个新的 Session 实例. 如果 partition 以 persist: 开头，那么这个page将使用一个持久的 session，这个 session 将对应用的所有 page 可用.如果没前缀，这个 page 将使用一个历史 session.如果 partition 为空，那么将返回应用的默认 session . 属性session 模块有如下属性: session.defaultSession返回应用的默认 session 对象. Class: Session可以在 session 模块中创建一个 Session 对象 : const session = require('electron').session;var ses = session.fromPartition('persist:name');实例事件实例 Session 有以下事件: Event: 'will-download'
当 Electron 将要从 webContents 下载 item 时触发. 调用 event.preventDefault() 可以取消下载，并且在进程的下个 tick中，这个 item 也不可用. session.defaultSession.on('will-download', function(event, item, webContents) {
event.preventDefault(); require('request')(item.getURL(), function(data) { require('fs').writeFileSync('/somewhere', data);
});
});实例方法实例 Session 有以下方法: ses.cookiescookies 赋予你全力来查询和修改 cookies. 例如: // 查询所有 cookies.session.defaultSession.cookies.get({}, function(error, cookies) { console.log(cookies);
});// 查询与指定 url 相关的所有 cookies.session.defaultSession.cookies.get({ url : "http://www.github.com" }, function(error, cookies) { console.log(cookies);
});// 设置 cookie;// may overwrite equivalent cookies if they exist.var cookie = { url : "http://www.github.com", name : "dummy_name", value : "dummy" };
session.defaultSession.cookies.set(cookie, function(error) { if (error) console.error(error);
});ses.cookies.get(filter, callback)
发送一个请求，希望获得所有匹配 details 的 cookies, 在完成的时候，将通过 callback(error, cookies) 调用 callback. cookies是一个 cookie 对象.
ses.cookies.set(details, callback)
使用 details 设置 cookie, 完成时使用 callback(error) 掉哟个 callback . ses.cookies.remove(url, name, callback)
删除匹配 url 和 name 的 cookie, 完成时使用 callback()调用callback. ses.getCacheSize(callback)
返回 session 的当前缓存 size . ses.clearCache(callback)
清空 session 的 HTTP 缓存. ses.clearStorageData([options, ]callback)
清除 web storages 的数据. ses.flushStorageData()将没有写入的 DOMStorage 写入磁盘. ses.setProxy(config, callback)
设置 proxy settings. 当 pacScript 和 proxyRules 一同提供时，将忽略 proxyRules，并且使用 pacScript 配置 . proxyRules 需要遵循下面的规则: proxyRules = schemeProxies[";"<schemeProxies>]schemeProxies = [<urlScheme>"="]<proxyURIList>urlScheme = "http" | "https" | "ftp" | "socks"proxyURIList = <proxyURL>[","<proxyURIList>]proxyURL = [<proxyScheme>"://"]<proxyHost>[":"<proxyPort>] 例子:
ses.resolveProxy(url, callback)
解析 url 的代理信息.当请求完成的时候使用 callback(proxy) 调用 callback. ses.setDownloadPath(path)
设置下载保存地址，默认保存地址为各自 app 应用的 Downloads目录. ses.enableNetworkEmulation(options)
通过给定配置的 session 来模拟网络. // 模拟 GPRS 连接，使用的 50kbps 流量，500 毫秒的 rtt.window.webContents.session.enableNetworkEmulation({
latency: 500,
downloadThroughput: 6400,
uploadThroughput: 6400});// 模拟网络故障.window.webContents.session.enableNetworkEmulation({offline: true});ses.disableNetworkEmulation()停止所有已经使用 session 的活跃模拟网络. 重置为原始网络类型. ses.setCertificateVerifyProc(proc)
为 session 设置证书验证过程，当请求一个服务器的证书验证时，使用 proc(hostname, certificate, callback) 调用 proc.调用 callback(true) 来接收证书，调用 callback(false) 来拒绝验证证书. 调用了 setCertificateVerifyProc(null) ，则将会回复到默认证书验证过程. myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, callback) { if (hostname == 'github.com')
callback(true); else
callback(false);
});ses.setPermissionRequestHandler(handler)
为对应 session 许可请求设置响应句柄.调用 callback(true) 接收许可，调用 callback(false) 禁止许可. session.fromPartition(partition).setPermissionRequestHandler(function(webContents, permission, callback) { if (webContents.getURL() === host) { if (permission == "notifications") {
callback(false); // denied.
return;
}
}
callback(true);
});ses.clearHostResolverCache([callback])
清除主机解析缓存. ses.webRequest在其生命周期的不同阶段，webRequest API 设置允许拦截并修改请求内容. 每个 API 接收一可选的 filter 和 listener，当 API 事件发生的时候使用 listener(details) 调用 listener，details 是一个用来描述请求的对象.为 listener 使用 null 则会退定事件. filter 是一个拥有 urls 属性的对象，这是一个 url 模式数组，这用来过滤掉不匹配指定 url 模式的请求.如果忽略 filter ，那么所有请求都将可以成功匹配. 所有事件的 listener 都有一个回调事件，当 listener 完成它的工作的时候，它将使用一个 response对象来调用. // 将所有请求的代理都修改为下列 url.var filter = {
urls: ["https://*.github.com/*", "*://electron.github.io"]
};
session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, callback) {
details.requestHeaders['User-Agent'] = "MyAgent";
callback({cancel: false, requestHeaders: details.requestHeaders});
});ses.webRequest.onBeforeRequest([filter, ]listener)
当一个请求即将开始的时候，使用 listener(details, callback) 调用 listener.
uploadData 是一个 data 数组对象:
callback 必须使用一个 response 对象来调用:
ses.webRequest.onBeforeSendHeaders([filter, ]listener)
一旦请求报文头可用了,在发送 HTTP 请求的之前，使用 listener(details, callback) 调用 listener.这也许会在服务器发起一个tcp 连接，但是在发送任何 http 数据之前发生.
必须使用一个 response 对象来调用 callback :
ses.webRequest.onSendHeaders([filter, ]listener)
在一个请求正在发送到服务器的时候，使用 listener(details) 来调用 listener ，之前 onBeforeSendHeaders 修改部分响应可用，同时取消监听.
ses.webRequest.onHeadersReceived([filter,] listener)
当 HTTP 请求报文头已经到达的时候，使用 listener(details, callback) 调用 listener .
必须使用一个 response 对象来调用 callback :
ses.webRequest.onResponseStarted([filter, ]listener)
当响应body的首字节到达的时候，使用 listener(details) 调用 listener.对 http 请求来说，这意味着状态线和响应头可用了.
ses.webRequest.onBeforeRedirect([filter, ]listener)
当服务器的重定向初始化正要启动时，使用 listener(details) 调用 listener.
ses.webRequest.onCompleted([filter, ]listener)
当请求完成的时候，使用 listener(details) 调用 listener.
ses.webRequest.onErrorOccurred([filter, ]listener)
当一个错误发生的时候，使用 listener(details) 调用 listener.
（编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |