Electron.NET/src/ElectronNET.API/API/Session.cs at develop · ElectronNET/Electron.NET · GitHub

History

377 lines (321 loc) · 14.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

using ElectronNET.API.Entities;

using System;

using System.Threading.Tasks;

namespace ElectronNET.API

{

/// <summary>

/// Manage browser sessions, cookies, cache, proxy settings, etc.

/// </summary>

public class Session

{

/// <summary>

/// Gets the identifier.

/// </summary>

/// <value>

/// The identifier.

/// </value>

public int Id { get; private set; }

/// <summary>

/// Query and modify a session's cookies.

/// </summary>

public Cookies Cookies { get; }

public WebRequest WebRequest { get; private set; }

internal Session(int id)

{

Id = id;

Cookies = new Cookies(id);

WebRequest = new WebRequest(id);

}

/// <summary>

/// Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate authentication.

/// </summary>

/// <param name="domains">A comma-separated list of servers for which integrated authentication is enabled.</param>

public void AllowNTLMCredentialsForDomains(string domains)

{

BridgeConnector.Socket.Emit("webContents-session-allowNTLMCredentialsForDomains", Id, domains);

}

/// <summary>

/// Clears the session’s HTTP authentication cache.

/// </summary>

/// <param name="options"></param>

/// <returns></returns>

public Task ClearAuthCacheAsync(RemovePassword options)

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearAuthCache-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearAuthCache", Id, options, guid);

return tcs.Task;

}

/// <summary>

/// Clears the session’s HTTP authentication cache.

/// </summary>

public Task ClearAuthCacheAsync()

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearAuthCache-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearAuthCache", Id, guid);

return tcs.Task;

}

/// <summary>

/// Clears the session’s HTTP cache.

/// </summary>

/// <returns></returns>

public Task ClearCacheAsync()

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearCache-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearCache", Id, guid);

return tcs.Task;

}

/// <summary>

/// Clears the host resolver cache.

/// </summary>

/// <returns></returns>

public Task ClearHostResolverCacheAsync()

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearHostResolverCache-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearHostResolverCache", Id, guid);

return tcs.Task;

}

/// <summary>

/// Clears the data of web storages.

/// </summary>

/// <returns></returns>

public Task ClearStorageDataAsync()

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearStorageData-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearStorageData", Id, guid);

return tcs.Task;

}

/// <summary>

/// Clears the data of web storages.

/// </summary>

/// <param name="options"></param>

/// <returns></returns>

public Task ClearStorageDataAsync(ClearStorageDataOptions options)

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-clearStorageData-options-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-clearStorageData-options", Id, options, guid);

return tcs.Task;

}

/// <summary>

/// Allows resuming cancelled or interrupted downloads from previous Session. The

/// API will generate a DownloadItem that can be accessed with the will-download

/// event. The DownloadItem will not have any WebContents associated with it and the

/// initial state will be interrupted. The download will start only when the resume

/// API is called on the DownloadItem.

/// </summary>

/// <param name="options"></param>

public void CreateInterruptedDownload(CreateInterruptedDownloadOptions options)

{

BridgeConnector.Socket.Emit("webContents-session-createInterruptedDownload", Id, options);

}

/// <summary>

/// Disables any network emulation already active for the session. Resets to the

/// original network configuration.

/// </summary>

public void DisableNetworkEmulation()

{

BridgeConnector.Socket.Emit("webContents-session-disableNetworkEmulation", Id);

}

/// <summary>

/// Emulates network with the given configuration for the session.

/// </summary>

/// <param name="options"></param>

public void EnableNetworkEmulation(EnableNetworkEmulationOptions options)

{

BridgeConnector.Socket.Emit("webContents-session-enableNetworkEmulation", Id, options);

}

/// <summary>

/// Writes any unwritten DOMStorage data to disk.

/// </summary>

public void FlushStorageData()

{

BridgeConnector.Socket.Emit("webContents-session-flushStorageData", Id);

}

/// <summary>

///

/// </summary>

/// <param name="identifier"></param>

/// <returns></returns>

public Task<int[]> GetBlobDataAsync(string identifier)

{

var tcs = new TaskCompletionSource<int[]>();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once<int[]>("webContents-session-getBlobData-completed" + guid, tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-getBlobData", Id, identifier, guid);

return tcs.Task;

}

/// <summary>

/// Get session's current cache size.

/// </summary>

/// <returns>Callback is invoked with the session's current cache size.</returns>

public Task<int> GetCacheSizeAsync()

{

var tcs = new TaskCompletionSource<int>();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once<int>("webContents-session-getCacheSize-completed" + guid, tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-getCacheSize", Id, guid);

return tcs.Task;

}

/// <summary>

///

/// </summary>

/// <returns></returns>

public Task<string[]> GetPreloadsAsync()

{

var tcs = new TaskCompletionSource<string[]>();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once<string[]>("webContents-session-getPreloads-completed" + guid, tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-getPreloads", Id, guid);

return tcs.Task;

}

/// <summary>

///

/// </summary>

/// <returns></returns>

public Task<string> GetUserAgent()

{

var tcs = new TaskCompletionSource<string>();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once<string>("webContents-session-getUserAgent-completed" + guid, tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-getUserAgent", Id, guid);

return tcs.Task;

}

/// <summary>

/// Resolves the proxy information for url. The callback will be called with

/// callback(proxy) when the request is performed.

/// </summary>

/// <param name="url"></param>

/// <returns></returns>

public Task<string> ResolveProxyAsync(string url)

{

var tcs = new TaskCompletionSource<string>();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once<string>("webContents-session-resolveProxy-completed" + guid, tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-resolveProxy", Id, url, guid);

return tcs.Task;

}

/// <summary>

/// Sets download saving directory. By default, the download directory will be the

/// Downloads under the respective app folder.

/// </summary>

/// <param name="path"></param>

public void SetDownloadPath(string path)

{

BridgeConnector.Socket.Emit("webContents-session-setDownloadPath", Id, path);

}

/// <summary>

/// Adds scripts that will be executed on ALL web contents that are associated with

/// this session just before normal preload scripts run.

/// </summary>

/// <param name="preloads"></param>

public void SetPreloads(string[] preloads)

{

BridgeConnector.Socket.Emit("webContents-session-setPreloads", Id, preloads);

}

/// <summary>

/// Sets the proxy settings. When pacScript and proxyRules are provided together,

/// the proxyRules option is ignored and pacScript configuration is applied.

/// </summary>

/// <param name="config"></param>

/// <returns></returns>

public Task SetProxyAsync(ProxyConfig config)

{

var tcs = new TaskCompletionSource();

string guid = Guid.NewGuid().ToString();

BridgeConnector.Socket.Once("webContents-session-setProxy-completed" + guid, () => tcs.SetResult());

BridgeConnector.Socket.Emit("webContents-session-setProxy", Id, config, guid);

return tcs.Task;

}

/// <summary>

/// Overrides the userAgent for this session. This doesn't affect existing WebContents, and

/// each WebContents can use webContents.setUserAgent to override the session-wide

/// user agent.

/// </summary>

/// <param name="userAgent"></param>

public void SetUserAgent(string userAgent)

{

BridgeConnector.Socket.Emit("webContents-session-setUserAgent", Id, userAgent);

}

/// <summary>

/// Overrides the userAgent and acceptLanguages for this session. The

/// acceptLanguages must a comma separated ordered list of language codes, for

/// example "en-US,fr,de,ko,zh-CN,ja". This doesn't affect existing WebContents, and

/// each WebContents can use webContents.setUserAgent to override the session-wide

/// user agent.

/// </summary>

/// <param name="userAgent"></param>

/// <param name="acceptLanguages">The

/// acceptLanguages must a comma separated ordered list of language codes, for

/// example "en-US,fr,de,ko,zh-CN,ja".</param>

public void SetUserAgent(string userAgent, string acceptLanguages)

{

BridgeConnector.Socket.Emit("webContents-session-setUserAgent", Id, userAgent, acceptLanguages);

}

/// <summary>

/// The keys are the extension names and each value is an object containing name and version properties.

/// Note: This API cannot be called before the ready event of the app module is emitted.

/// </summary>

/// <returns></returns>

public Task<ChromeExtensionInfo[]> GetAllExtensionsAsync()

{

var tcs = new TaskCompletionSource<ChromeExtensionInfo[]>();

BridgeConnector.Socket.Once<ChromeExtensionInfo[]>("webContents-session-getAllExtensions-completed", tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-getAllExtensions", Id);

return tcs.Task;

}

/// <summary>

/// Remove Chrome extension with the specified name.

/// Note: This API cannot be called before the ready event of the app module is emitted.

/// </summary>

/// <param name="name">Name of the Chrome extension to remove</param>

public void RemoveExtension(string name)

{

BridgeConnector.Socket.Emit("webContents-session-removeExtension", Id, name);

}

/// <summary>

/// resolves when the extension is loaded.

///

/// This method will raise an exception if the extension could not be loaded.If

/// there are warnings when installing the extension (e.g. if the extension requests

/// an API that Electron does not support) then they will be logged to the console.

///

/// Note that Electron does not support the full range of Chrome extensions APIs.

/// See Supported Extensions APIs for more details on what is supported.

///

/// Note that in previous versions of Electron, extensions that were loaded would be

/// remembered for future runs of the application.This is no longer the case:

/// `loadExtension` must be called on every boot of your app if you want the

/// extension to be loaded.

///

/// This API does not support loading packed (.crx) extensions.

///

///** Note:** This API cannot be called before the `ready` event of the `app` module

/// is emitted.

///

///** Note:** Loading extensions into in-memory(non-persistent) sessions is not supported and will throw an error.

/// </summary>

/// <param name="path">Path to the Chrome extension</param>

/// <param name="allowFileAccess">Whether to allow the extension to read local files over `file://` protocol and

/// inject content scripts into `file://` pages. This is required e.g. for loading

/// devtools extensions on `file://` URLs. Defaults to false.</param>

/// <returns></returns>

public Task<Extension> LoadExtensionAsync(string path, bool allowFileAccess = false)

{

var tcs = new TaskCompletionSource<Extension>();

BridgeConnector.Socket.Once<Extension>("webContents-session-loadExtension-completed", tcs.SetResult);

BridgeConnector.Socket.Emit("webContents-session-loadExtension", Id, path, allowFileAccess);

return tcs.Task;

}

Electron.NET/src/ElectronNET.API/API/Session.cs at develop · ElectronNET/Electron.NET · GitHub

Uh oh!

Uh oh!

Electron.NET/src/ElectronNET.API/API/Session.cs at develop · ElectronNET/Electron.NET · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

Session.cs

Latest commit

History

Breadcrumbs

Session.cs

File metadata and controls