Add pop-up policy support in website policies.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / _WKWebsitePolicies.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <WebKit/WKFoundation.h>
27
28 #if WK_API_ENABLED
29
30 typedef NS_ENUM(NSInteger, _WKWebsiteAutoplayPolicy) {
31     _WKWebsiteAutoplayPolicyDefault,
32     _WKWebsiteAutoplayPolicyAllow,
33     _WKWebsiteAutoplayPolicyAllowWithoutSound,
34     _WKWebsiteAutoplayPolicyDeny
35 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
36
37 typedef NS_OPTIONS(NSUInteger, _WKWebsiteAutoplayQuirk) {
38     _WKWebsiteAutoplayQuirkSynthesizedPauseEvents = 1 << 0,
39     _WKWebsiteAutoplayQuirkInheritedUserGestures = 1 << 1,
40     _WKWebsiteAutoplayQuirkArbitraryUserGestures = 1 << 2,
41 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
42
43 typedef NS_OPTIONS(NSUInteger, _WKWebsitePopUpPolicy) {
44     _WKWebsitePopUpPolicyDefault,
45     _WKWebsitePopUpPolicyAllow,
46     _WKWebsitePopUpPolicyBlock,
47 } WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
48
49 @class WKWebsiteDataStore;
50
51 WK_CLASS_AVAILABLE(macosx(10.12.3), ios(10.3))
52 @interface _WKWebsitePolicies : NSObject
53
54 @property (nonatomic) BOOL contentBlockersEnabled;
55 @property (nonatomic) _WKWebsiteAutoplayQuirk allowedAutoplayQuirks WK_API_AVAILABLE(macosx(10.13), ios(11.0));
56 @property (nonatomic) _WKWebsiteAutoplayPolicy autoplayPolicy WK_API_AVAILABLE(macosx(10.13), ios(11.0));
57 @property (nonatomic, copy) NSDictionary<NSString *, NSString *> *customHeaderFields WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
58 @property (nonatomic) _WKWebsitePopUpPolicy popUpPolicy WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
59 @property (nonatomic, strong) WKWebsiteDataStore *websiteDataStore WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
60
61 @end
62
63 #endif // WK_API_ENABLED