Fix a header comment
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKUserContentController.h
1 /*
2  * Copyright (C) 2014 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 #import <Foundation/Foundation.h>
31
32 @class WKUserScript;
33 @protocol WKScriptMessageHandler;
34
35 /*! WKUserContentController provides a way for JavaScript to post messages to the @link WKWebView @/link.
36  A @link WKWebView @/link can specify which WKUserContentController object it uses through its @link WKWebViewConfiguration @/link.
37  */
38 WK_CLASS_AVAILABLE(10_10, 8_0)
39 @interface WKUserContentController : NSObject
40
41 /*! @abstract The user scripts associated with this user content controller.
42 */
43 @property (nonatomic, readonly) NSArray *userScripts;
44
45 /*! @abstract Adds a user script.
46  @param userScript The user script to add.
47 */
48 - (void)addUserScript:(WKUserScript *)userScript;
49
50 /*! @abstract Removes all associated user scripts.
51 */
52 - (void)removeAllUserScripts;
53
54 /*! @abstract Adds a script message handler.
55  @param scriptMessageHandler The message handler where the messages should be delivered.
56  @param name The name of the message handler.
57  @discussion Adding a scriptMessageHandler adds a function window.webkit.messageHandlers.<name>.postMessage(<messageBody>) for all frames.
58  */
59 - (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
60
61 /*! @abstract Removes a script message handler.
62  @param name The name of the message handler to remove.
63  */
64 - (void)removeScriptMessageHandlerForName:(NSString *)name;
65
66 @end
67
68 #endif