Skip to content

Commit bbc6e45

Browse files
committed
Add xml doc to RequestContextSettings
1 parent 76687cf commit bbc6e45

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CefSharp.Core/RequestContextSettings.h

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ namespace CefSharp
1818
CefRequestContextSettings* _settings;
1919

2020
public:
21+
/// <summary>
22+
/// Default constructor
23+
/// </summary>
2124
RequestContextSettings() : _settings(new CefRequestContextSettings())
2225
{
2326
}
@@ -32,24 +35,56 @@ namespace CefSharp
3235
this->!RequestContextSettings();
3336
}
3437

38+
/// <summary>
39+
/// To persist session cookies (cookies without an expiry date or validity
40+
/// interval) by default when using the global cookie manager set this value to
41+
/// true. Session cookies are generally intended to be transient and most
42+
/// Web browsers do not persist them. Can be set globally using the
43+
/// CefSettings.PersistSessionCookies value. This value will be ignored if
44+
/// CachePath is empty or if it matches the CefSettings.CachePath value.
45+
/// </summary>
3546
property bool PersistSessionCookies
3647
{
3748
bool get() { return _settings->persist_session_cookies == 1; }
3849
void set(bool value) { _settings->persist_session_cookies = value; }
3950
}
4051

52+
/// <summary>
53+
/// The location where cache data will be stored on disk. If empty then
54+
/// browsers will be created in "incognito mode" where in-memory caches are
55+
/// used for storage and no data is persisted to disk. HTML5 databases such as
56+
/// localStorage will only persist across sessions if a cache path is
57+
/// specified. To share the global browser cache and related configuration set
58+
/// this value to match the CefSettings.CachePath value.
59+
/// </summary>
4160
property String^ CachePath
4261
{
4362
String^ get() { return StringUtils::ToClr(_settings->cache_path); }
4463
void set(String^ value) { StringUtils::AssignNativeFromClr(_settings->cache_path, value); }
4564
}
4665

66+
/// <summary>
67+
/// Comma delimited ordered list of language codes without any whitespace that
68+
/// will be used in the "Accept-Language" HTTP header. Can be set globally
69+
/// using the CefSettings.accept_language_list value or overridden on a per-
70+
/// browser basis using the BrowserSettings.AcceptLanguageList value. If
71+
/// all values are empty then "en-US,en" will be used. This value will be
72+
/// ignored if CachePath matches the CefSettings.CachePath value.
73+
/// </summary>
4774
property String^ AcceptLanguageList
4875
{
4976
String^ get() { return StringUtils::ToClr(_settings->accept_language_list); }
5077
void set(String^ value) { StringUtils::AssignNativeFromClr(_settings->accept_language_list, value); }
5178
}
5279

80+
/// <summary>
81+
/// Set to true to ignore errors related to invalid SSL certificates.
82+
/// Enabling this setting can lead to potential security vulnerabilities like
83+
/// "man in the middle" attacks. Applications that load content from the
84+
/// internet should not enable this setting. Can be set globally using the
85+
/// CefSettings.IgnoreCertificateErrors value. This value will be ignored if
86+
/// CachePath matches the CefSettings.cache_path value.
87+
/// </summary>
5388
property bool IgnoreCertificateErrors
5489
{
5590
bool get() { return _settings->ignore_certificate_errors == 1; }

0 commit comments

Comments
 (0)