Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKURLSchemeHandler.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 WKWebView;
33 @protocol WKURLSchemeTask;
34
35 /*! A class conforming to the WKURLSchemeHandler protocol provides methods for
36  loading resources with URL schemes that WebKit doesn't know how to handle itself.
37  */
38 WK_API_AVAILABLE(macos(10.13), ios(11.0))
39 @protocol WKURLSchemeHandler <NSObject>
40
41 /*! @abstract Notifies your app to start loading the data for a particular resource 
42  represented by the URL scheme handler task.
43  @param webView The web view invoking the method.
44  @param urlSchemeTask The task that your app should start loading data for.
45  */
46 - (void)webView:(WKWebView *)webView startURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask;
47
48 /*! @abstract Notifies your app to stop handling a URL scheme handler task.
49  @param webView The web view invoking the method.
50  @param urlSchemeTask The task that your app should stop handling.
51  @discussion After your app is told to stop loading data for a URL scheme handler task
52  it must not perform any callbacks for that task.
53  An exception will be thrown if any callbacks are made on the URL scheme handler task
54  after your app has been told to stop loading for it.
55  */
56 - (void)webView:(WKWebView *)webView stopURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask;
57
58 @end
59
60 NS_ASSUME_NONNULL_END