[Cocoa] Get rid of WK_ macros for nullability
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKUserContentController.h
index 7251212fed8d9ea343161fc9b9a6969fa8af7a36..c98ef2e03b8c35ef3e3181b77136fdbb407d9516 100644 (file)
  * THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#import <Foundation/Foundation.h>
-#import <WebKit2/WKFoundation.h>
+#import <WebKit/WKFoundation.h>
 
 #if WK_API_ENABLED
 
-@class WKScriptWorld;
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class WKUserScript;
 @protocol WKScriptMessageHandler;
 
-WK_API_CLASS
+/*! A WKUserContentController object provides a way for JavaScript to post
+ messages to a web view.
+ The user content controller associated with a web view is specified by its
+ web view configuration.
+ */
+WK_CLASS_AVAILABLE(10_10, 8_0)
 @interface WKUserContentController : NSObject
 
-- (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name world:(WKScriptWorld *)world;
-- (void)removeScriptMessageHandlerForName:(NSString *)name world:(WKScriptWorld *)world;
+/*! @abstract The user scripts associated with this user content
+ controller.
+*/
+@property (nonatomic, readonly, copy) WK_ARRAY(WKUserScript *) *userScripts;
 
-@end
+/*! @abstract Adds a user script.
+ @param userScript The user script to add.
+*/
+- (void)addUserScript:(WKUserScript *)userScript;
 
-#endif
+/*! @abstract Removes all associated user scripts.
+*/
+- (void)removeAllUserScripts;
 
+/*! @abstract Adds a script message handler.
+ @param scriptMessageHandler The message handler to add.
+ @param name The name of the message handler.
+ @discussion Adding a scriptMessageHandler adds a function
+ window.webkit.messageHandlers.<name>.postMessage(<messageBody>) for all
+ frames.
+ */
+- (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
+
+/*! @abstract Removes a script message handler.
+ @param name The name of the message handler to remove.
+ */
+- (void)removeScriptMessageHandlerForName:(NSString *)name;
 
+@end
+
+NS_ASSUME_NONNULL_END
+
+#endif