Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKWebsiteDataStore.h
1 /*
2  * Copyright (C) 2014-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 <WebKit/WKFoundation.h>
27
28 #import <WebKit/WKWebsiteDataRecord.h>
29
30 NS_ASSUME_NONNULL_BEGIN
31
32 @class WKHTTPCookieStore;
33
34 /*! A WKWebsiteDataStore represents various types of data that a website might
35  make use of. This includes cookies, disk and memory caches, and persistent data such as WebSQL,
36  IndexedDB databases, and local storage.
37  */
38 WK_CLASS_AVAILABLE(macos(10.11), ios(9.0))
39 @interface WKWebsiteDataStore : NSObject <NSSecureCoding>
40
41 /* @abstract Returns the default data store. */
42 + (WKWebsiteDataStore *)defaultDataStore;
43
44 /** @abstract Returns a new non-persistent data store.
45  @discussion If a WKWebView is associated with a non-persistent data store, no data will
46  be written to the file system. This is useful for implementing "private browsing" in a web view.
47 */
48 + (WKWebsiteDataStore *)nonPersistentDataStore;
49
50 - (instancetype)init NS_UNAVAILABLE;
51
52 /*! @abstract Whether the data store is persistent or not. */
53 @property (nonatomic, readonly, getter=isPersistent) BOOL persistent;
54
55 /*! @abstract Returns a set of all available website data types. */
56 + (NSSet<NSString *> *)allWebsiteDataTypes;
57
58 /*! @abstract Fetches data records containing the given website data types.
59   @param dataTypes The website data types to fetch records for.
60   @param completionHandler A block to invoke when the data records have been fetched.
61 */
62 - (void)fetchDataRecordsOfTypes:(NSSet<NSString *> *)dataTypes completionHandler:(void (^)(NSArray<WKWebsiteDataRecord *> *))completionHandler;
63
64 /*! @abstract Removes website data of the given types for the given data records.
65  @param dataTypes The website data types that should be removed.
66  @param dataRecords The website data records to delete website data for.
67  @param completionHandler A block to invoke when the website data for the records has been removed.
68 */
69 - (void)removeDataOfTypes:(NSSet<NSString *> *)dataTypes forDataRecords:(NSArray<WKWebsiteDataRecord *> *)dataRecords completionHandler:(void (^)(void))completionHandler;
70
71 /*! @abstract Removes all website data of the given types that has been modified since the given date.
72  @param dataTypes The website data types that should be removed.
73  @param date A date. All website data modified after this date will be removed.
74  @param completionHandler A block to invoke when the website data has been removed.
75 */
76 - (void)removeDataOfTypes:(NSSet<NSString *> *)dataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler;
77
78 /*! @abstract Returns the cookie store representing HTTP cookies in this website data store. */
79 @property (nonatomic, readonly) WKHTTPCookieStore *httpCookieStore WK_API_AVAILABLE(macos(10.13), ios(11.0));
80
81 @end
82
83 NS_ASSUME_NONNULL_END