forked from Heikowi/HWIFileDownload
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HWIFileDownloader.h
143 lines (105 loc) · 4.99 KB
/
HWIFileDownloader.h
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
/*
* Project: HWIFileDownload
* Created by Heiko Wichmann (20140928)
* File: HWIFileDownloader.h
*
*/
/***************************************************************************
Copyright (c) 2014 Heiko Wichmann
https://github.com/Heikowi/HWIFileDownload
This software is provided 'as-is', without any expressed or implied warranty.
In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated
but is not required.
2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
***************************************************************************/
#import <Foundation/Foundation.h>
#import "HWIFileDownloadDelegate.h"
#import "HWIBackgroundSessionCompletionHandlerBlock.h"
#import "HWIFileDownloadProgress.h"
/**
HWIFileDownloaderCancelResumeDataBlock is a block optionally called after cancelling a download.
*/
typedef void (^HWIFileDownloaderCancelResumeDataBlock)(NSData *aResumeData);
/**
HWIFileDownloader coordinates download activities.
*/
@interface HWIFileDownloader : NSObject
- (NSArray *)allDownloadItems;
/**
Secondary initializer.
@param aDelegate Delegate for salient download events.
@return HWIFileDownloader.
*/
- (instancetype)initWithDelegate:(NSObject<HWIFileDownloadDelegate>*)aDelegate;
/**
Designated initializer.
@param aDelegate Delegate for salient download events.
@param aMaxConcurrentFileDownloadsCount Maximum number of concurrent downloads. Default: no limit.
@return HWIFileDownloader.
*/
- (instancetype)initWithDelegate:(NSObject<HWIFileDownloadDelegate>*)aDelegate maxConcurrentDownloads:(NSInteger)aMaxConcurrentFileDownloadsCount allowCellular:(BOOL)allowCellular;
- (instancetype)initWithDelegate:(NSObject<HWIFileDownloadDelegate>*)aDelegate allowCellular:(BOOL)allowCellular;
- (instancetype)initWithDelegate:(NSObject<HWIFileDownloadDelegate>*)aDelegate maxConcurrentDownloads:(NSInteger)aMaxConcurrentFileDownloadsCount;
- (instancetype)init __attribute__((unavailable("use initWithDelegate:maxConcurrentDownloads: or initWithDelegate:")));
+ (instancetype)new __attribute__((unavailable("use initWithDelegate:maxConcurrentDownloads: or initWithDelegate:")));
// download
/**
Starts a download.
@param aDownloadIdentifier Download identifier of a download item.
@param aRemoteURL Remote URL from where data should be downloaded.
*/
- (void)startDownloadWithDownloadIdentifier:(NSString *)aDownloadIdentifier
fromRemoteURL:(NSURL *)aRemoteURL;
/**
Starts a download.
@param aDownloadIdentifier Download identifier of a download item.
@param aResumeData Incomplete data from previous download with implicit remote source information.
*/
- (void)startDownloadWithDownloadIdentifier:(NSString *)aDownloadIdentifier
usingResumeData:(NSData *)aResumeData;
/**
Answers the question whether a download is currently running for a download item.
@param aDownloadIdentifier Download identifier of the download item.
@return YES if a download is currently running for the download item, NO otherwise.
*/
- (BOOL)isDownloadingIdentifier:(NSString *)aDownloadIdentifier;
/**
Answers the question whether any download is currently running.
@return YES if any download is currently running, NO otherwise.
*/
- (BOOL)hasActiveDownloads;
/**
Cancels the download of a download item.
@param aDownloadIdentifier Download identifier of the download item.
@remarks Convenience method, calls cancelDownloadWithIdentifier:resumeDataBlock: with nil as resumeDataBlock.
*/
- (void)cancelDownloadWithIdentifier:(NSString *)aDownloadIdentifier;
/**
Cancels the download of a download item.
@param aDownloadIdentifier Download identifier of the download item.
@param aResumeDataBlock Asynchronously called block with resume data.
*/
- (void)cancelDownloadWithIdentifier:(NSString *)aDownloadIdentifier resumeDataBlock:(HWIFileDownloaderCancelResumeDataBlock)aResumeDataBlock;
/**
Sets the completion handler for background session.
@param aBackgroundSessionCompletionHandlerBlock Completion handler block.
*/
- (void)setBackgroundSessionCompletionHandlerBlock:(HWIBackgroundSessionCompletionHandlerBlock)aBackgroundSessionCompletionHandlerBlock;
// progress
/**
Returns download progress information for a download item.
@param aDownloadIdentifier Download identifier of the download item.
@return Download progress information.
*/
- (HWIFileDownloadProgress *)downloadProgressForIdentifier:(NSString *)aDownloadIdentifier;
@end