Skip to content

Commit 1ae9e01

Browse files
committed
Core - PermissionHandler followup
- Rename enums (remove cef prefix) - Fix typos - Slightly improve docs
1 parent f92687b commit 1ae9e01

12 files changed

+45
-44
lines changed

CefSharp.Core.Runtime/Internals/CefMediaAccessCallbackWrapper.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ namespace CefSharp
4545
delete this;
4646
}
4747

48-
virtual void Continue(CefMediaAccessPermissionType allowedPermissions)
48+
virtual void Continue(MediaAccessPermissionType allowedPermissions)
4949
{
5050
ThrowIfDisposed();
5151

CefSharp.Core.Runtime/Internals/CefPermissionPromptCallbackWrapper.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ namespace CefSharp
3636
_disposed = true;
3737
}
3838

39-
virtual void Continue(CefPermissionResult result)
39+
virtual void Continue(PermissionRequestResult result)
4040
{
4141
ThrowIfDisposed();
4242

CefSharp.Core.Runtime/Internals/ClientAdapter.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1194,7 +1194,7 @@ namespace CefSharp
11941194
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
11951195
auto callbackWrapper = gcnew CefPermissionPromptCallbackWrapper(callback);
11961196

1197-
return handler->OnShowPermissionPrompt(_browserControl, browserWrapper, prompt_id, StringUtils::ToClr(requesting_origin), (CefPermissionType)requested_permissions, callbackWrapper);
1197+
return handler->OnShowPermissionPrompt(_browserControl, browserWrapper, prompt_id, StringUtils::ToClr(requesting_origin), (PermissionRequestType)requested_permissions, callbackWrapper);
11981198
}
11991199

12001200
return false;
@@ -1208,7 +1208,7 @@ namespace CefSharp
12081208
{
12091209
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
12101210

1211-
handler->OnDismissPermissionPrompt(_browserControl, browserWrapper, prompt_id, (CefPermissionResult)result);
1211+
handler->OnDismissPermissionPrompt(_browserControl, browserWrapper, prompt_id, (PermissionRequestResult)result);
12121212
}
12131213
}
12141214

@@ -1223,7 +1223,7 @@ namespace CefSharp
12231223
CefFrameWrapper frameWrapper(frame);
12241224
auto callbackWrapper = gcnew CefMediaAccessCallbackWrapper(callback);
12251225

1226-
return handler->OnRequestMediaAccessPermission(_browserControl, browserWrapper, %frameWrapper, StringUtils::ToClr(requesting_origin), (CefMediaAccessPermissionType)requested_permissions, callbackWrapper);
1226+
return handler->OnRequestMediaAccessPermission(_browserControl, browserWrapper, %frameWrapper, StringUtils::ToClr(requesting_origin), (MediaAccessPermissionType)requested_permissions, callbackWrapper);
12271227
}
12281228
return false;
12291229
}

CefSharp.Example/Handlers/PermissionHandlerExample.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ namespace CefSharp.Example.Handlers
88
{
99
public class PermissionHandlerExample : PermissionHandler
1010
{
11-
protected override bool OnShowPermissionPrompt(IWebBrowser chromiumWebBrowser, IBrowser browser, ulong promptId, string requestingOrigin, CefPermissionType requestedPermissions, IPermissionPromptCallback callback)
11+
protected override bool OnShowPermissionPrompt(IWebBrowser chromiumWebBrowser, IBrowser browser, ulong promptId, string requestingOrigin, PermissionRequestType requestedPermissions, IPermissionPromptCallback callback)
1212
{
1313
using (callback)
1414
{
1515
System.Diagnostics.Debug.WriteLine($"{promptId}|{requestedPermissions} {requestingOrigin}");
16-
callback.Continue(CefPermissionResult.Accept);
16+
callback.Continue(PermissionRequestResult.Accept);
1717
return true;
1818
}
1919
}
2020

21-
protected override void OnDismissPermissionPrompt(IWebBrowser chromiumWebBrowser, IBrowser browser, ulong promptId, CefPermissionResult result)
21+
protected override void OnDismissPermissionPrompt(IWebBrowser chromiumWebBrowser, IBrowser browser, ulong promptId, PermissionRequestResult result)
2222
{
2323
base.OnDismissPermissionPrompt(chromiumWebBrowser, browser, promptId, result);
2424
}
2525

26-
protected override bool OnRequestMediaAccessPermission(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, string requestingOrigin, CefMediaAccessPermissionType requestedPermissions, IMediaAccessCallback callback)
26+
protected override bool OnRequestMediaAccessPermission(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, string requestingOrigin, MediaAccessPermissionType requestedPermissions, IMediaAccessCallback callback)
2727
{
2828
using (callback)
2929
{
30-
callback.Continue(CefMediaAccessPermissionType.AudioCapture |
31-
CefMediaAccessPermissionType.VideoCapture |
32-
CefMediaAccessPermissionType.DesktopVideoCapture |
33-
CefMediaAccessPermissionType.DesktopAudioCapture);
30+
callback.Continue(MediaAccessPermissionType.AudioCapture |
31+
MediaAccessPermissionType.VideoCapture |
32+
MediaAccessPermissionType.DesktopVideoCapture |
33+
MediaAccessPermissionType.DesktopAudioCapture);
3434
return true;
3535
}
3636
}

CefSharp/Callback/IMediaAccessCallback.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface IMediaAccessCallback : IDisposable
2020
/// <see cref="IPermissionHandler.OnRequestMediaAccessPermission"/>
2121
/// </summary>
2222
/// <param name="allowedPermissions">Allowed Permissions</param>
23-
void Continue(CefMediaAccessPermissionType allowedPermissions);
23+
void Continue(MediaAccessPermissionType allowedPermissions);
2424

2525
/// <summary>
2626
/// Cancel the media access request.

CefSharp/Callback/IPermissionPromptCallback.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ public interface IPermissionPromptCallback : IDisposable
1515
/// Complete the permissions request with the specified result.
1616
/// </summary>
1717
/// <param name="result">Permission request results.</param>
18-
void Continue(CefPermissionResult result);
18+
void Continue(PermissionRequestResult result);
1919
}
2020
}

CefSharp/DevTools/DevToolsDomainBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ protected IEnumerable<string> EnumToString(ContentEncoding[] values)
100100
}
101101
}
102102

103-
protected IEnumerable<string> EnumToString(PermissionType[] values)
103+
protected IEnumerable<string> EnumToString(Browser.PermissionType[] values)
104104
{
105105
foreach (var val in values)
106106
{

CefSharp/Enums/CefMediaAccessPermissionType.cs renamed to CefSharp/Enums/MediaAccessPermissionType.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
namespace CefSharp
88
{
99
/// <summary>
10-
/// Media access permissions used by OnRequestMediaAccessPermission.
10+
/// Media access permissions used by <see cref="IPermissionHandler.OnRequestMediaAccessPermission(IWebBrowser, IBrowser, IFrame, string, MediaAccessPermissionType, IMediaAccessCallback)"/>.
1111
/// </summary>
1212
[Flags]
13-
public enum CefMediaAccessPermissionType : uint
13+
public enum MediaAccessPermissionType : uint
1414
{
1515
/// <summary>
1616
/// No permission.

CefSharp/Enums/CefPermissionResult.cs renamed to CefSharp/Enums/PermissionRequestResult.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace CefSharp
77
/// <summary>
88
/// Permission request results.
99
/// </summary>
10-
public enum CefPermissionResult : uint
10+
public enum PermissionRequestResult : uint
1111
{
1212
/// <summary>
1313
/// Accept the permission request as an explicit user action.

CefSharp/Enums/CefPermissionType.cs renamed to CefSharp/Enums/PermissionRequestType.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
namespace CefSharp
88
{
99
/// <summary>
10-
/// Permission types used with OnShowPermissionPrompt. Some types are
11-
/// platform-specific or only supported with the Chrome runtime. Should be kept
10+
/// Permission types used with <see cref="IPermissionHandler.OnShowPermissionPrompt(IWebBrowser, IBrowser, ulong, string, PermissionRequestType, IPermissionPromptCallback)"/>.
11+
/// Some types are platform-specific or only supported with the Chrome runtime. Should be kept
1212
/// in sync with Chromium's permissions::RequestType type.
1313
/// </summary>
1414
[Flags]
15-
public enum CefPermissionType : uint
15+
public enum PermissionRequestType : uint
1616
{
1717
None = 0,
18-
AccessibiLityEvents = 1 << 0,
18+
AccessibilityEvents = 1 << 0,
1919
ArSession = 1 << 1,
2020
CameraPanTiltZoom = 1 << 2,
2121
CameraStream = 1 << 3,
@@ -34,6 +34,6 @@ public enum CefPermissionType : uint
3434
StorageAccess = 1 << 16,
3535
U2FApiRequest = 1 << 17,
3636
VrSession = 1 << 18,
37-
Windowplacement = 1 << 19
37+
WindowPlacement = 1 << 19
3838
}
3939
}

0 commit comments

Comments
 (0)