92d586e413e20989dfaa8964a0aa5fd1b84fe3b1
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKScriptMessage.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 WK_ASSUME_NONNULL_BEGIN
33
34 @class WKFrameInfo;
35 @class WKWebView;
36
37 /*! A WKScriptMessage object contains information about a message sent from
38  a webpage.
39  */
40 WK_CLASS_AVAILABLE(10_10, 8_0)
41 @interface WKScriptMessage : NSObject
42
43 /*! @abstract The body of the message.
44  @discussion Allowed types are NSNumber, NSString, NSDate, NSArray,
45  NSDictionary, and NSNull.
46  */
47 @property (nonatomic, readonly, copy) id body;
48
49 /*! @abstract The web view sending the message. */
50 @property (WK_NULLABLE_PROPERTY nonatomic, readonly, weak) WKWebView *webView;
51
52 /*! @abstract The frame sending the message. */
53 @property (nonatomic, readonly, copy) WKFrameInfo *frameInfo;
54
55 /*! @abstract The name of the message handler to which the message is sent.
56  */
57 @property (nonatomic, readonly, copy) NSString *name;
58
59 @end
60
61 WK_ASSUME_NONNULL_END
62
63 #endif