[iOS] Send the full list of file upload URLs and types in PasteboardItemInfo
[WebKit-https.git] / Source / WebCore / platform / ios / AbstractPasteboard.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 #import <Foundation/Foundation.h>
27
28 #if TARGET_OS_IPHONE
29
30 NS_ASSUME_NONNULL_BEGIN
31
32 #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
33 @class WebItemProviderRegistrationInfoList;
34 #endif
35
36 @protocol AbstractPasteboard <NSObject>
37 @required
38
39 @property (readonly, nonatomic) NSInteger numberOfItems;
40
41 #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
42 @property (nonatomic, copy, nullable) NSArray<__kindof NSItemProvider *> *itemProviders;
43 #endif
44
45 - (NSArray<NSString *> *)pasteboardTypes;
46 - (NSData *)dataForPasteboardType:(NSString *)pasteboardType;
47 - (NSArray *)dataForPasteboardType:(NSString *)pasteboardType inItemSet:(NSIndexSet *)itemSet;
48 - (NSArray *)valuesForPasteboardType:(NSString *)pasteboardType inItemSet:(NSIndexSet *)itemSet;
49 - (NSInteger)changeCount;
50
51 @optional
52 #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
53 - (void)stageRegistrationList:(nullable WebItemProviderRegistrationInfoList *)info;
54 - (nullable WebItemProviderRegistrationInfoList *)takeRegistrationList;
55 #endif
56 - (void)setItems:(NSArray<NSDictionary *> *)items;
57 - (NSArray<NSString *> *)pasteboardTypesByFidelityForItemAtIndex:(NSUInteger)index;
58 @property (readonly, nonatomic) NSInteger numberOfFiles;
59 @property (readonly, nonatomic) NSArray<NSURL *> *allDroppedFileURLs;
60
61 // Computes lists of file URLs and types. Each file URL and type corresponds to a representation of the item provider at the given index.
62 // In order from highest fidelity to lowest fidelity.
63 - (NSArray<NSURL *> *)fileUploadURLsAtIndex:(NSUInteger)index fileTypes:(NSArray<NSString *> *_Nullable *_Nonnull)outFileTypes;
64 - (void)updateSupportedTypeIdentifiers:(NSArray<NSString *> *)types;
65
66 @end
67
68 NS_ASSUME_NONNULL_END
69
70 #endif // TARGET_OS_IPHONE