WKScriptMessage.h 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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. #import <WebKit/WKFoundation.h>
  26. #import <Foundation/Foundation.h>
  27. NS_ASSUME_NONNULL_BEGIN
  28. @class WKFrameInfo;
  29. @class WKWebView;
  30. /*! A WKScriptMessage object contains information about a message sent from
  31. a webpage.
  32. */
  33. WK_EXTERN API_AVAILABLE(macos(10.10), ios(8.0))
  34. @interface WKScriptMessage : NSObject
  35. /*! @abstract The body of the message.
  36. @discussion Allowed types are NSNumber, NSString, NSDate, NSArray,
  37. NSDictionary, and NSNull.
  38. */
  39. @property (nonatomic, readonly, copy) id body;
  40. /*! @abstract The web view sending the message. */
  41. @property (nullable, nonatomic, readonly, weak) WKWebView *webView;
  42. /*! @abstract The frame sending the message. */
  43. @property (nonatomic, readonly, copy) WKFrameInfo *frameInfo;
  44. /*! @abstract The name of the message handler to which the message is sent.
  45. */
  46. @property (nonatomic, readonly, copy) NSString *name;
  47. @end
  48. NS_ASSUME_NONNULL_END