aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Storage/Private/FIRStorageConstants_Private.h
blob: 50addb1d6da19c8cdfff747b588ed5a5c2b1748c (plain)
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
/*
 * 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 FIRStorageMetadata;

NS_ASSUME_NONNULL_BEGIN

FOUNDATION_EXPORT NSString *const kGCSScheme;
FOUNDATION_EXPORT NSString *const kGCSHost;
FOUNDATION_EXPORT NSString *const kGCSUploadPath;
FOUNDATION_EXPORT NSString *const kGCSStorageVersionPath;
FOUNDATION_EXPORT NSString *const kGCSBucketPathFormat;
FOUNDATION_EXPORT NSString *const kGCSObjectPathFormat;

FOUNDATION_EXPORT NSString *const kFIRStorageScheme;
FOUNDATION_EXPORT NSString *const kFIRStorageHost;
FOUNDATION_EXPORT NSString *const kFIRStorageVersionPath;
FOUNDATION_EXPORT NSString *const kFIRStorageBucketPathFormat;
FOUNDATION_EXPORT NSString *const kFIRStorageObjectPathFormat;
FOUNDATION_EXPORT NSString *const kFIRStorageFullPathFormat;

FOUNDATION_EXPORT NSString *const kFIRStorageAuthTokenFormat;
FOUNDATION_EXPORT NSString *const kFIRStorageDefaultBucketFormat;

FOUNDATION_EXPORT NSString *const kFIRStorageResponseErrorDomain;
FOUNDATION_EXPORT NSString *const kFIRStorageResponseErrorCode;
FOUNDATION_EXPORT NSString *const kFIRStorageResponseBody;

FOUNDATION_EXPORT NSString *const kFIRStorageTaskStatusResumeNotification;
FOUNDATION_EXPORT NSString *const kFIRStorageTaskStatusPauseNotification;
FOUNDATION_EXPORT NSString *const kFIRStorageTaskStatusProgressNotification;
FOUNDATION_EXPORT NSString *const kFIRStorageTaskStatusCompleteNotification;
FOUNDATION_EXPORT NSString *const kFIRStorageTaskStatusFailureNotification;

FOUNDATION_EXPORT NSString *const kFIRStorageMetadataBucket;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataCacheControl;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataContentDisposition;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataContentEncoding;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataContentLanguage;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataContentType;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataCustomMetadata;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataSize;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataDownloadURLs;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataGeneration;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataMetageneration;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataTimeCreated;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataUpdated;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataName;
FOUNDATION_EXPORT NSString *const kFIRStorageMetadataDownloadTokens;

FOUNDATION_EXPORT NSString *const kFIRStorageInvalidDataFormat;
FOUNDATION_EXPORT NSString *const kFIRStorageInvalidObserverStatus;

FOUNDATION_EXPORT NSString *const kFIRStorageBundleIdentifier;

/**
 * Enum representing the internal state of an upload or download task.
 */
typedef NS_ENUM(NSInteger, FIRStorageTaskState) {
  /**
   * Unknown task state
   */
  FIRStorageTaskStateUnknown,

  /**
   * Task is being queued is ready to run
   */
  FIRStorageTaskStateQueueing,

  /**
   * Task is resuming from a paused state
   */
  FIRStorageTaskStateResuming,

  /**
   * Task is currently running
   */
  FIRStorageTaskStateRunning,

  /**
   * Task reporting a progress event
   */
  FIRStorageTaskStateProgress,

  /**
   * Task is pausing
   */
  FIRStorageTaskStatePausing,

  /**
   * Task is completing successfully
   */
  FIRStorageTaskStateCompleting,

  /**
   * Task is failing unrecoverably
   */
  FIRStorageTaskStateFailing,

  /**
   * Task paused successfully
   */
  FIRStorageTaskStatePaused,

  /**
   * Task cancelled successfully
   */
  FIRStorageTaskStateCancelled,

  /**
   * Task completed successfully
   */
  FIRStorageTaskStateSuccess,

  /**
   * Task failed unrecoverably
   */
  FIRStorageTaskStateFailed
};

/**
 * Represents the various types of metadata: Files or Folders.
 */
typedef NS_ENUM(NSUInteger, FIRStorageMetadataType) {
  FIRStorageMetadataTypeUnknown,
  FIRStorageMetadataTypeFile,
  FIRStorageMetadataTypeFolder,
};

NS_ASSUME_NONNULL_END