Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKHTTPCookieStore.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 <WebKit/WKFoundation.h>
27
28 #import <Foundation/Foundation.h>
29
30 NS_ASSUME_NONNULL_BEGIN
31
32 @class WKHTTPCookieStore;
33
34 WK_API_AVAILABLE(macos(10.13), ios(11.0))
35 @protocol WKHTTPCookieStoreObserver <NSObject>
36 @optional
37 - (void)cookiesDidChangeInCookieStore:(WKHTTPCookieStore *)cookieStore;
38 @end
39
40 /*!
41  A WKHTTPCookieStore object allows managing the HTTP cookies associated with a particular WKWebsiteDataStore.
42  */
43 WK_CLASS_AVAILABLE(macos(10.13), ios(11.0))
44 @interface WKHTTPCookieStore : NSObject
45
46 - (instancetype)init NS_UNAVAILABLE;
47
48 /*! @abstract Fetches all stored cookies.
49  @param completionHandler A block to invoke with the fetched cookies.
50  */
51 - (void)getAllCookies:(void (^)(NSArray<NSHTTPCookie *> *))completionHandler;
52
53 /*! @abstract Set a cookie.
54  @param cookie The cookie to set.
55  @param completionHandler A block to invoke once the cookie has been stored.
56  */
57 - (void)setCookie:(NSHTTPCookie *)cookie completionHandler:(nullable void (^)(void))completionHandler;
58
59 /*! @abstract Delete the specified cookie.
60  @param completionHandler A block to invoke once the cookie has been deleted.
61  */
62 - (void)deleteCookie:(NSHTTPCookie *)cookie completionHandler:(nullable void (^)(void))completionHandler;
63
64 /*! @abstract Adds a WKHTTPCookieStoreObserver object with the cookie store.
65  @param observer The observer object to add.
66  @discussion The observer is not retained by the receiver. It is your responsibility
67  to unregister the observer before it becomes invalid.
68  */
69 - (void)addObserver:(id<WKHTTPCookieStoreObserver>)observer;
70
71 /*! @abstract Removes a WKHTTPCookieStoreObserver object from the cookie store.
72  @param observer The observer to remove.
73  */
74 - (void)removeObserver:(id<WKHTTPCookieStoreObserver>)observer;
75
76 @end
77
78 NS_ASSUME_NONNULL_END