This repository has been archived by the owner on Feb 19, 2020. It is now read-only.
/
BITUpdateManagerDelegate.h
160 lines (120 loc) · 5.94 KB
/
BITUpdateManagerDelegate.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
* Author: Andreas Linde <mail@andreaslinde.de>
*
* Copyright (c) 2012-2014 HockeyApp, Bit Stadium GmbH.
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#import <Foundation/Foundation.h>
@class BITUpdateManager;
/**
The `BITUpdateManagerDelegate` formal protocol defines methods further configuring
the behaviour of `BITUpdateManager`.
*/
@protocol BITUpdateManagerDelegate <NSObject>
@optional
///-----------------------------------------------------------------------------
/// @name Update
///-----------------------------------------------------------------------------
/**
Return if update alert should be shown
If you want to display your own user interface when there is an update available,
implement this method, present your user interface and return _NO_. In this case
it is your responsibility to call `BITUpdateManager showUpdateView`
Note: This delegate will be invoked on startup and every time the app becomes
active again!
When returning _YES_ the default blocking UI will be shown.
When running the app from the App Store, this delegate is ignored.
@param updateManager The `BITUpdateManager` instance invoking this delegate
@param shortVersion The latest available version
@param version The latest available version
*/
- (BOOL)shouldDisplayUpdateAlertForUpdateManager:(BITUpdateManager *)updateManager forShortVersion:(NSString *)shortVersion forVersion:(NSString *)version;
///-----------------------------------------------------------------------------
/// @name Expiry
///-----------------------------------------------------------------------------
/**
Return if expiry alert should be shown if date is reached
If you want to display your own user interface when the expiry date is reached,
implement this method, present your user interface and return _NO_. In this case
it is your responsibility to make the app unusable!
Note: This delegate will be invoked on startup and every time the app becomes
active again!
When returning _YES_ the default blocking UI will be shown.
When running the app from the App Store, this delegate is ignored.
@param updateManager The `BITUpdateManager` instance invoking this delegate
@see [BITUpdateManager expiryDate]
@see [BITUpdateManagerDelegate didDisplayExpiryAlertForUpdateManager:]
*/
- (BOOL)shouldDisplayExpiryAlertForUpdateManager:(BITUpdateManager *)updateManager;
/**
Invoked once a default expiry alert is shown
Once expiry date is reached and the default blocking UI is shown,
this delegate method is invoked to provide you the possibility to do any
desired additional processing.
@param updateManager The `BITUpdateManager` instance invoking this delegate
@see [BITUpdateManager expiryDate]
@see [BITUpdateManagerDelegate shouldDisplayExpiryAlertForUpdateManager:]
*/
- (void)didDisplayExpiryAlertForUpdateManager:(BITUpdateManager *)updateManager;
///-----------------------------------------------------------------------------
/// @name Privacy
///-----------------------------------------------------------------------------
/** Return NO if usage data should not be send
The update module send usage data by default, if the application is _NOT_
running in an App Store version. Implement this delegate and
return NO if you want to disable this.
If you intend to implement a user setting to let them enable or disable
sending usage data, this delegate should be used to return that value.
Usage data contains the following information:
- App Version
- iOS Version
- Device type
- Language
- Installation timestamp
- Usage time
@param updateManager The `BITUpdateManager` instance invoking this delegate
@warning When setting this to `NO`, you will _NOT_ know if this user is actually testing!
*/
- (BOOL)updateManagerShouldSendUsageData:(BITUpdateManager *)updateManager;
///-----------------------------------------------------------------------------
/// @name Privacy
///-----------------------------------------------------------------------------
/** Implement this method to be notified before an update starts.
The update manager will send this delegate message _just_ before the system
call to update the application is placed, but after the user has already chosen
to install the update.
There is no guarantee that the update will actually start after this delegate
message is sent.
@param updateManager The `BITUpdateManager` instance invoking this delegate
*/
- (BOOL)willStartDownloadAndUpdate:(BITUpdateManager *)updateManager;
/**
Invoked right before the app will exit to allow app update to start (>= iOS8 only)
The iOS installation mechanism only starts if the app the should be updated is currently
not running. On all iOS versions up to iOS 7, the system did automatically exit the app
in these cases. Since iOS 8 this isn't done any longer.
@param updateManager The `BITUpdateManager` instance invoking this delegate
*/
- (void)updateManagerWillExitApp:(BITUpdateManager *)updateManager;
@end