Update availability annotations to match the macOS and iOS SDKs in the Xcode 10 GM...
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / _WKAttachment.h
1 /*
2  * Copyright (C) 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 #pragma once
27
28 #import <WebKit/WKFoundation.h>
29
30 #if WK_API_ENABLED
31
32 NS_ASSUME_NONNULL_BEGIN
33
34 typedef NS_ENUM(NSInteger, _WKAttachmentDisplayMode) {
35     _WKAttachmentDisplayModeAuto = 1,
36     _WKAttachmentDisplayModeInPlace,
37     _WKAttachmentDisplayModeAsIcon
38 } WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
39
40 WK_CLASS_AVAILABLE(macosx(10.13.4), ios(11.3))
41 @interface _WKAttachmentDisplayOptions : NSObject
42 @property (nonatomic) _WKAttachmentDisplayMode mode;
43 @end
44
45 WK_CLASS_AVAILABLE(macosx(10.14), ios(12.0))
46 @interface _WKAttachmentInfo : NSObject
47 @property (nonatomic, readonly, nullable) NSString *contentType;
48 @property (nonatomic, readonly, nullable) NSString *name;
49 @property (nonatomic, readonly, nullable) NSString *filePath;
50 @property (nonatomic, readonly, nullable) NSData *data;
51 @property (nonatomic, readonly, nullable) NSFileWrapper *fileWrapper;
52 @end
53
54 WK_CLASS_AVAILABLE(macosx(10.13.4), ios(11.3))
55 @interface _WKAttachment : NSObject
56
57 - (void)setFileWrapper:(NSFileWrapper *)fileWrapper contentType:(nullable NSString *)contentType completion:(void(^ _Nullable)(NSError * _Nullable))completionHandler WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
58
59 @property (nonatomic, readonly, nullable) _WKAttachmentInfo *info WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
60 @property (nonatomic, readonly) NSString *uniqueIdentifier;
61 @property (nonatomic, readonly, getter=isConnected) BOOL connected WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
62
63 // Deprecated SPI.
64 - (void)requestInfo:(void(^)(_WKAttachmentInfo * _Nullable, NSError * _Nullable))completionHandler WK_API_DEPRECATED_WITH_REPLACEMENT("-info", macosx(10.14, WK_MAC_TBA), ios(12.0, WK_IOS_TBA));
65 - (void)setData:(NSData *)data newContentType:(nullable NSString *)newContentType newFilename:(nullable NSString *)newFilename completion:(void(^ _Nullable)(NSError * _Nullable))completionHandler WK_API_DEPRECATED_WITH_REPLACEMENT("Please use -setFileWrapper:contentType:completion: instead.", macosx(10.13.4, WK_MAC_TBA), ios(11.3, WK_IOS_TBA));
66
67 @end
68
69 NS_ASSUME_NONNULL_END
70
71 #endif