FIRStorageDownloadTask.h 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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. #import <Foundation/Foundation.h>
  17. #import "FIRStorageObservableTask.h"
  18. #import "FIRStorageSwiftNameSupport.h"
  19. NS_ASSUME_NONNULL_BEGIN
  20. /**
  21. * FIRStorageDownloadTask implements resumable downloads from an object in Firebase Storage.
  22. * Downloads can be returned on completion with a completion handler, and can be monitored
  23. * by attaching observers, or controlled by calling FIRStorageTask#pause, FIRStorageTask#resume,
  24. * or FIRStorageTask#cancel.
  25. * Downloads can currently be returned as NSData in memory, or as an NSURL to a file on disk.
  26. * Downloads are performed on a background queue, and callbacks are raised on the developer
  27. * specified callbackQueue in FIRStorage, or the main queue if left unspecified.
  28. * Currently all uploads must be initiated and managed on the main queue.
  29. */
  30. FIR_SWIFT_NAME(StorageDownloadTask)
  31. @interface FIRStorageDownloadTask : FIRStorageObservableTask<FIRStorageTaskManagement>
  32. @end
  33. NS_ASSUME_NONNULL_END