blob: a7307a7dac4ac886298d2ffaaa6d536ce3df6cd4 (
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
|
/*
* Copyright 2019 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 FIRInstanceIDAuthKeychain;
@class FIRInstanceIDBackupExcludedPlist;
@class FIRInstanceIDCheckinPreferences;
// These values exposed for testing
extern NSString *const kFIRInstanceIDCheckinKeychainService;
/**
* Checkin preferences backing store.
*/
@interface FIRInstanceIDCheckinStore : NSObject
/**
* Designated Initializer. Initialize a checkin store with the given backup excluded
* plist filename.
*
* @param checkinFilename The backup excluded plist filename to persist checkin
* preferences.
*
* @param subDirectoryName Sub-directory in standard directory where we write
* InstanceID plist.
*
* @return Store to persist checkin preferences.
*/
- (instancetype)initWithCheckinPlistFileName:(NSString *)checkinFilename
subDirectoryName:(NSString *)subDirectoryName;
/**
* Initialize a checkin store with the given backup excluded plist and keychain.
*
* @param plist The backup excluded plist to persist checkin preferences.
* @param keychain The keychain used to persist checkin auth preferences.
*
* @return Store to persist checkin preferences.
*/
- (instancetype)initWithCheckinPlist:(FIRInstanceIDBackupExcludedPlist *)plist
keychain:(FIRInstanceIDAuthKeychain *)keychain;
/**
* Checks whether the backup excluded checkin preferences are present on the disk or not.
*
* @return YES if the backup excluded checkin plist exists on the disks else NO.
*/
- (BOOL)hasCheckinPlist;
#pragma mark - Save
/**
* Save the checkin preferences to backing store.
*
* @param preferences Checkin preferences to save.
* @param handler The callback handler which is invoked when the operation is complete,
* with an error if there is any.
*/
- (void)saveCheckinPreferences:(FIRInstanceIDCheckinPreferences *)preferences
handler:(void (^)(NSError *error))handler;
#pragma mark - Delete
/**
* Remove the cached checkin preferences.
*
* @param handler The callback handler which is invoked when the operation is complete,
* with an error if there is any.
*/
- (void)removeCheckinPreferencesWithHandler:(void (^)(NSError *error))handler;
#pragma mark - Get
/**
* Get the cached device secret. If we cannot access it for some reason we
* return the appropriate error object.
*
* @return The cached checkin preferences if present else nil.
*/
- (FIRInstanceIDCheckinPreferences *)cachedCheckinPreferences;
@end
|
