Remove STREAMS_API compilation guard
[WebKit-https.git] / Source / WebKitLegacy / mac / WebView / WebResource.h
1 /*
2  * Copyright (C) 2004, 2005 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <Foundation/Foundation.h>
30
31 @class WebResourcePrivate;
32
33
34 /*!
35     @class WebResource
36     @discussion A WebResource represents a fully downloaded URL. 
37     It includes the data of the resource as well as the metadata associated with the resource.
38 */
39 @interface WebResource : NSObject <NSCoding, NSCopying>
40 {
41 @package
42     WebResourcePrivate *_private;
43 }
44
45 /*!
46     @method initWithData:URL:MIMEType:textEncodingName:frameName
47     @abstract The initializer for WebResource.
48     @param data The data of the resource.
49     @param URL The URL of the resource.
50     @param MIMEType The MIME type of the resource.
51     @param textEncodingName The text encoding name of the resource (can be nil).
52     @param frameName The frame name of the resource if the resource represents the contents of an entire HTML frame (can be nil).
53     @result An initialized WebResource.
54 */
55 - (instancetype)initWithData:(NSData *)data URL:(NSURL *)URL MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)textEncodingName frameName:(NSString *)frameName;
56
57 /*!
58     @property data
59     @abstract The data of the resource.
60 */
61 @property (nonatomic, readonly, copy) NSData *data;
62
63 /*!
64     @property URL
65     @abstract The URL of the resource.
66 */
67 @property (nonatomic, readonly, strong) NSURL *URL;
68
69 /*!
70     @property MIMEType
71     @abstract The MIME type of the resource.
72 */
73 @property (nonatomic, readonly, copy) NSString *MIMEType;
74
75 /*!
76     @property textEncodingName
77     @abstract The text encoding name of the resource (can be nil).
78 */
79 @property (nonatomic, readonly, copy) NSString *textEncodingName;
80
81 /*!
82     @property frameName
83     @abstract The frame name of the resource if the resource represents the contents of an entire HTML frame (can be nil).
84 */
85 @property (nonatomic, readonly, copy) NSString *frameName;
86
87 @end