Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKUserContentController.h
1 /*
2  * Copyright (C) 2014-2017 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 #import <Foundation/Foundation.h>
29
30 NS_ASSUME_NONNULL_BEGIN
31
32 @class WKContentRuleList;
33 @class WKUserScript;
34 @protocol WKScriptMessageHandler;
35
36 /*! A WKUserContentController object provides a way for JavaScript to post
37  messages to a web view.
38  The user content controller associated with a web view is specified by its
39  web view configuration.
40  */
41 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
42 @interface WKUserContentController : NSObject <NSSecureCoding>
43
44 /*! @abstract The user scripts associated with this user content
45  controller.
46 */
47 @property (nonatomic, readonly, copy) NSArray<WKUserScript *> *userScripts;
48
49 /*! @abstract Adds a user script.
50  @param userScript The user script to add.
51 */
52 - (void)addUserScript:(WKUserScript *)userScript;
53
54 /*! @abstract Removes all associated user scripts.
55 */
56 - (void)removeAllUserScripts;
57
58 /*! @abstract Adds a script message handler.
59  @param scriptMessageHandler The message handler to add.
60  @param name The name of the message handler.
61  @discussion Adding a scriptMessageHandler adds a function
62  window.webkit.messageHandlers.<name>.postMessage(<messageBody>) for all
63  frames.
64  */
65 - (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
66
67 /*! @abstract Removes a script message handler.
68  @param name The name of the message handler to remove.
69  */
70 - (void)removeScriptMessageHandlerForName:(NSString *)name;
71
72 /*! @abstract Adds a content rule list.
73  @param contentRuleList The content rule list to add.
74  */
75 - (void)addContentRuleList:(WKContentRuleList *)contentRuleList WK_API_AVAILABLE(macos(10.13), ios(11.0));
76
77 /*! @abstract Removes a content rule list.
78  @param contentRuleList The content rule list to remove.
79  */
80 - (void)removeContentRuleList:(WKContentRuleList *)contentRuleList WK_API_AVAILABLE(macos(10.13), ios(11.0));
81
82 /*! @abstract Removes all associated content rule lists.
83  */
84 - (void)removeAllContentRuleLists WK_API_AVAILABLE(macos(10.13), ios(11.0));
85
86 @end
87
88 NS_ASSUME_NONNULL_END