FIRStorageDownloadTask_Private.h 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. /*
  2. * Copyright 2017 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. @class GTMSessionFetcherService;
  17. NS_ASSUME_NONNULL_BEGIN
  18. @interface FIRStorageDownloadTask ()
  19. /**
  20. * Bytes which have been downloaded so far.
  21. */
  22. @property(readonly, nonatomic) NSData *downloadData;
  23. /**
  24. * The file on disk to write to.
  25. */
  26. @property(copy, nonatomic) NSURL *fileURL;
  27. /**
  28. * Initializes a download task with a base FIRStorageReference and GTMSessionFetcherService.
  29. * @param reference The base FIRStorageReference which fetchers use for configuration.
  30. * @param service The GTMSessionFetcherService which will create fetchers.
  31. * @param queue The shared queue to use for all Storage operations.
  32. * @param fileURL The system URL to download to. If nil, download in memory as bytes.
  33. * @return Returns an instance of FIRStorageDownloadTask
  34. */
  35. - (instancetype)initWithReference:(FIRStorageReference *)reference
  36. fetcherService:(GTMSessionFetcherService *)service
  37. dispatchQueue:(dispatch_queue_t)queue
  38. file:(nullable NSURL *)fileURL;
  39. /**
  40. * Cancels the download task and passes an appropriate error to the developer.
  41. * @param error NSError to propegate to the developer.
  42. */
  43. - (void)cancelWithError:(NSError *)error;
  44. @end
  45. NS_ASSUME_NONNULL_END