1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
@class FIRStorageDownloadTask;
@class FIRStorageMetadata;
@class FIRStorageTaskSnapshot;
@class FIRStorageUploadTask;
NS_ASSUME_NONNULL_BEGIN
/**
* NSString typedef representing a task listener handle.
*/
typedef NSString *FIRStorageHandle NS_SWIFT_NAME(StorageHandle);
/**
* Block typedef typically used when downloading data.
* @param data The data returned by the download, or nil if no data available or download failed.
* @param error The error describing failure, if one occurred.
*/
typedef void (^FIRStorageVoidDataError)(NSData *_Nullable data, NSError *_Nullable error)
NS_SWIFT_NAME(StorageVoidDataError);
/**
* Block typedef typically used when performing "binary" async operations such as delete,
* where the operation either succeeds without an error or fails with an error.
* @param error The error describing failure, if one occurred.
*/
typedef void (^FIRStorageVoidError)(NSError *_Nullable error) NS_SWIFT_NAME(StorageVoidError);
/**
* Block typedef typically used when retrieving metadata.
* @param metadata The metadata returned by the operation, if metadata exists.
*/
typedef void (^FIRStorageVoidMetadata)(FIRStorageMetadata *_Nullable metadata)
NS_SWIFT_NAME(StorageVoidMetadata);
/**
* Block typedef typically used when retrieving metadata with the possibility of an error.
* @param metadata The metadata returned by the operation, if metadata exists.
* @param error The error describing failure, if one occurred.
*/
typedef void (^FIRStorageVoidMetadataError)(FIRStorageMetadata *_Nullable metadata,
NSError *_Nullable error)
NS_SWIFT_NAME(StorageVoidMetadataError);
/**
* Block typedef typically used to asynchronously return a storage task snapshot.
* @param snapshot The returned task snapshot.
*/
typedef void (^FIRStorageVoidSnapshot)(FIRStorageTaskSnapshot *snapshot)
NS_SWIFT_NAME(StorageVoidSnapshot);
/**
* Block typedef typically used when retrieving a download URL.
* @param URL The download URL associated with the operation.
* @param error The error describing failure, if one occurred.
*/
typedef void (^FIRStorageVoidURLError)(NSURL *_Nullable URL, NSError *_Nullable error)
NS_SWIFT_NAME(StorageVoidURLError);
/**
* Enum representing the upload and download task status.
*/
typedef NS_ENUM(NSInteger, FIRStorageTaskStatus) {
/**
* Unknown task status.
*/
FIRStorageTaskStatusUnknown,
/**
* Task is being resumed.
*/
FIRStorageTaskStatusResume,
/**
* Task reported a progress event.
*/
FIRStorageTaskStatusProgress,
/**
* Task is paused.
*/
FIRStorageTaskStatusPause,
/**
* Task has completed successfully.
*/
FIRStorageTaskStatusSuccess,
/**
* Task has failed and is unrecoverable.
*/
FIRStorageTaskStatusFailure
} NS_SWIFT_NAME(StorageTaskStatus);
/**
* Firebase Storage error domain.
*/
FOUNDATION_EXPORT NSString *const FIRStorageErrorDomain NS_SWIFT_NAME(StorageErrorDomain);
/**
* Enum representing the errors raised by Firebase Storage.
*/
typedef NS_ENUM(NSInteger, FIRStorageErrorCode) {
/** An unknown error occurred. */
FIRStorageErrorCodeUnknown = -13000,
/** No object exists at the desired reference. */
FIRStorageErrorCodeObjectNotFound = -13010,
/** No bucket is configured for Firebase Storage. */
FIRStorageErrorCodeBucketNotFound = -13011,
/** No project is configured for Firebase Storage. */
FIRStorageErrorCodeProjectNotFound = -13012,
/**
* Quota on your Firebase Storage bucket has been exceeded.
* If you're on the free tier, upgrade to a paid plan.
* If you're on a paid plan, reach out to Firebase support.
*/
FIRStorageErrorCodeQuotaExceeded = -13013,
/** User is unauthenticated. Authenticate and try again. */
FIRStorageErrorCodeUnauthenticated = -13020,
/**
* User is not authorized to perform the desired action.
* Check your rules to ensure they are correct.
*/
FIRStorageErrorCodeUnauthorized = -13021,
/**
* The maximum time limit on an operation (upload, download, delete, etc.) has been exceeded.
* Try uploading again.
*/
FIRStorageErrorCodeRetryLimitExceeded = -13030,
/**
* File on the client does not match the checksum of the file received by the server.
* Try uploading again.
*/
FIRStorageErrorCodeNonMatchingChecksum = -13031,
/**
* Size of the downloaded file exceeds the amount of memory allocated for the download.
* Increase memory cap and try downloading again.
*/
FIRStorageErrorCodeDownloadSizeExceeded = -13032,
/** User cancelled the operation. */
FIRStorageErrorCodeCancelled = -13040
} NS_SWIFT_NAME(StorageErrorCode);
NS_ASSUME_NONNULL_END
|
