-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Expand file tree
/
Copy pathIRequestContext.cs
More file actions
270 lines (248 loc) · 15.2 KB
/
IRequestContext.cs
File metadata and controls
270 lines (248 loc) · 15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
// Copyright © 2015 The CefSharp Authors. All rights reserved.
//
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using CefSharp.Enums;
namespace CefSharp
{
/// <summary>
/// A request context provides request handling for a set of related browser or URL request objects.
/// A request context can be specified when creating a new browser by setting the
/// <see cref="IWebBrowser.RequestContext"/> property (Passing in via the constructor for the OffScreen
/// control is preferred).
/// Browser objects with different request contexts will never be hosted in the same render process.
/// Browser objects with the same request context may or may not be hosted in the same render process
/// depending on the process model.Browser objects created indirectly via the JavaScript window.open
/// function or targeted links will share the same render process and the same request context as
/// the source browser.
/// </summary>
public interface IRequestContext : IDisposable
{
/// <summary>
/// Gets a value indicating whether the RequestContext has been disposed of.
/// </summary>
bool IsDisposed { get; }
/// <summary>
/// Returns true if this object is pointing to the same context object.
/// </summary>
/// <param name="context">context to compare</param>
/// <returns>Returns true if the same</returns>
bool IsSame(IRequestContext context);
/// <summary>
/// Returns true if this object is sharing the same storage as the specified context.
/// </summary>
/// <param name="context">context to compare</param>
/// <returns>Returns true if same storage</returns>
bool IsSharingWith(IRequestContext context);
/// <summary>
/// Returns true if this object is the global context. The global context is
/// used by default when creating a browser or URL request with a NULL context
/// argument.
/// </summary>
bool IsGlobal { get; }
/// <summary>
/// Returns the default cookie manager for this object. This will be the global
/// cookie manager if this object is the global request context.
/// </summary>
/// <param name="callback">If callback is non-NULL it will be executed asynchronously on the CEF IO thread
/// after the manager's storage has been initialized.</param>
/// <returns>Returns the default cookie manager for this object</returns>
ICookieManager GetCookieManager(ICompletionCallback callback);
/// <summary>
/// Register a scheme handler factory for the specified schemeName and optional domainName.
/// An empty domainName value for a standard scheme will cause the factory to match all domain
/// names. The domainName value will be ignored for non-standard schemes. If schemeName is
/// a built-in scheme and no handler is returned by factory then the built-in scheme handler
/// factory will be called. If schemeName is a custom scheme then you must also implement the
/// CefApp::OnRegisterCustomSchemes() method in all processes. This function may be called multiple
/// times to change or remove the factory that matches the specified schemeName and optional
/// domainName.
/// </summary>
/// <param name="schemeName">Scheme Name</param>
/// <param name="domainName">Optional domain name</param>
/// <param name="factory">Scheme handler factory</param>
/// <returns>Returns false if an error occurs.</returns>
bool RegisterSchemeHandlerFactory(string schemeName, string domainName, ISchemeHandlerFactory factory);
/// <summary>
/// Clear all registered scheme handler factories.
/// </summary>
/// <returns>Returns false on error.</returns>
bool ClearSchemeHandlerFactories();
/// <summary>
/// Returns the cache path for this object. If empty an "incognito mode"
/// in-memory cache is being used.
/// </summary>
string CachePath { get; }
/// <summary>
/// Returns true if a preference with the specified name exists. This method
/// must be called on the CEF UI thread.
/// </summary>
/// <param name="name">name of preference</param>
/// <returns>bool if the preference exists</returns>
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
/// executed on the CEF UI thread, so can be called directly.
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
/// application thread will be the CEF UI thread.</remarks>
bool HasPreference(string name);
/// <summary>
/// Returns the value for the preference with the specified name. Returns
/// NULL if the preference does not exist. The returned object contains a copy
/// of the underlying preference value and modifications to the returned object
/// will not modify the underlying preference value. This method must be called
/// on the CEF UI thread.
/// </summary>
/// <param name="name">preference name</param>
/// <returns>Returns the value for the preference with the specified name</returns>
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
/// executed on the CEF UI thread, so can be called directly.
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
/// application thread will be the CEF UI thread.</remarks>
object GetPreference(string name);
/// <summary>
/// Returns all preferences as a dictionary. The returned
/// object contains a copy of the underlying preference values and
/// modifications to the returned object will not modify the underlying
/// preference values. This method must be called on the browser process UI
/// thread.
/// </summary>
/// <param name="includeDefaults">If true then
/// preferences currently at their default value will be included.</param>
/// <returns>Preferences (dictionary can have sub dictionaries)</returns>
IDictionary<string, object> GetAllPreferences(bool includeDefaults);
/// <summary>
/// Returns true if the preference with the specified name can be modified
/// using SetPreference. As one example preferences set via the command-line
/// usually cannot be modified. This method must be called on the CEF UI thread.
/// </summary>
/// <param name="name">preference key</param>
/// <returns>Returns true if the preference with the specified name can be modified
/// using SetPreference</returns>
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
/// executed on the CEF UI thread, so can be called directly.
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
/// application thread will be the CEF UI thread.</remarks>
bool CanSetPreference(string name);
/// <summary>
/// Set the value associated with preference name. If value is null the
/// preference will be restored to its default value. If setting the preference
/// fails then error will be populated with a detailed description of the
/// problem. This method must be called on the CEF UI thread.
/// Preferences set via the command-line usually cannot be modified.
/// </summary>
/// <param name="name">preference key</param>
/// <param name="value">preference value</param>
/// <param name="error">out error</param>
/// <returns>Returns true if the value is set successfully and false otherwise.</returns>
/// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
/// <see cref="IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
/// executed on the CEF UI thread, so can be called directly.
/// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
/// application thread will be the CEF UI thread.</remarks>
bool SetPreference(string name, object value, out string error);
/// <summary>
/// Clears all certificate exceptions that were added as part of handling
/// <see cref="IRequestHandler.OnCertificateError"/>. If you call this it is
/// recommended that you also call <see cref="IRequestContext.CloseAllConnections"/> or you risk not
/// being prompted again for server certificates if you reconnect quickly.
/// </summary>
/// <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
/// completion. This param is optional</param>
void ClearCertificateExceptions(ICompletionCallback callback);
/// <summary>
/// Clears all HTTP authentication credentials that were added as part of handling
/// <see cref="IRequestHandler.GetAuthCredentials"/>.
/// </summary>
/// <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
/// completion. This param is optional</param>
void ClearHttpAuthCredentials(ICompletionCallback callback = null);
/// <summary>
/// Clears all active and idle connections that Chromium currently has.
/// This is only recommended if you have released all other CEF objects but
/// don't yet want to call Cef.Shutdown().
/// </summary>
/// <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
/// completion. This param is optional</param>
void CloseAllConnections(ICompletionCallback callback);
/// <summary>
/// Attempts to resolve origin to a list of associated IP addresses.
/// </summary>
/// <param name="origin">host name to resolve</param>
/// <returns>A task that represents the Resoolve Host operation. The value of the TResult parameter contains ResolveCallbackResult.</returns>
Task<ResolveCallbackResult> ResolveHostAsync(Uri origin);
/// <summary>
/// Returns the current value for <paramref name="contentType"/> that applies for the
/// specified URLs. If both URLs are empty the default value will be returned.
/// Returns null if no value is configured.
/// Must be called on the browser
/// process UI thread.
/// </summary>
/// <param name="requestingUrl">Requesting url</param>
/// <param name="topLevelUrl">Top level url</param>
/// <param name="contentType">Content type</param>
/// <returns>Returns the current value for <paramref name="contentType"/> that applies for the
/// specified URLs.</returns>
object GetWebsiteSetting(string requestingUrl, string topLevelUrl, ContentSettingTypes contentType);
/// <summary>
/// Sets the current value for <paramref name="contentType"/> for the specified URLs in the
/// default scope. If both URLs are empty, and the context is not incognito,
/// the default value will be set. Pass null for <paramref name="value"/> to remove the
/// default value for this content type.
///
/// WARNING: Incorrect usage of this method may cause instability or security
/// issues in Chromium. Make sure that you first understand the potential
/// impact of any changes to <paramref name="contentType"/> by reviewing the related source
/// code in Chromium. For example, if you plan to modify
/// <see cref="ContentSettingTypes.Popups"/>, first review and understand the usage of
/// ContentSettingsType::POPUPS in Chromium:
/// https://source.chromium.org/search?q=ContentSettingsType::POPUPS
/// </summary>
/// <param name="requestingUrl">Requesting url</param>
/// <param name="topLevelUrl">Top level url</param>
/// <param name="contentType">Content type</param>
/// <param name="value">value </param>
void SetWebsiteSetting(string requestingUrl, string topLevelUrl, ContentSettingTypes contentType, object value);
/// <summary>
/// Returns the current value for <paramref name="contentType"/> that applies for the
/// specified URLs. If both URLs are empty the default value will be returned.
/// Returns <see cref="ContentSettingValues.Default"/> if no value is configured. Must
/// be called on the browser process UI thread.
/// </summary>
/// <param name="requestingUrl">Requesting url</param>
/// <param name="topLevelUrl">Top level url</param>
/// <param name="contentType">Content type</param>
/// <returns>Returns the current value for <paramref name="contentType"/> that applies for the
/// specified URLs.</returns>
ContentSettingValues GetContentSetting(string requestingUrl, string topLevelUrl, ContentSettingTypes contentType);
/// <summary>
/// Sets the current value for <paramref name="contentType"/> for the specified URLs in the
/// default scope. If both URLs are empty, and the context is not incognito,
/// the default value will be set. Pass <see cref="ContentSettingValues.Default"/> for
/// <paramref name="value"/> to use the default value for this content type.
///
/// WARNING: Incorrect usage of this method may cause instability or security
/// issues in Chromium. Make sure that you first understand the potential
/// impact of any changes to |content_type| by reviewing the related source
/// code in Chromium. For example, if you plan to modify
/// <see cref="ContentSettingTypes.Popups"/>, first review and understand the usage of
/// ContentSettingsType::POPUPS in Chromium:
/// https://source.chromium.org/search?q=ContentSettingsType::POPUPS
/// </summary>
/// <param name="requestingUrl">Requesting url</param>
/// <param name="topLevelUrl">Top level url</param>
/// <param name="contentType">Content type</param>
/// <param name="value">value</param>
void SetContentSetting(string requestingUrl, string topLevelUrl, ContentSettingTypes contentType, ContentSettingValues value);
/// <summary>
/// Used internally to get the underlying <see cref="IRequestContext"/> instance.
/// Unlikely you'll use this yourself.
/// </summary>
/// <returns>the inner most instance</returns>
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
IRequestContext UnWrap();
}
}