lpw
2021-01-26 454098c2f508505fc55c60c577250b8610abaaf3
commit | author | age
a6c014 1 /*
L 2  * Copyright 2019 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
17 #import <Foundation/Foundation.h>
18
19 NS_ASSUME_NONNULL_BEGIN
20
21 /// Stores either a date or a dictionary to a specified file.
22 @interface GULHeartbeatDateStorage : NSObject
23
24 - (instancetype)init NS_UNAVAILABLE;
25
26 @property(nonatomic, readonly) NSURL *fileURL;
27
28 /**
29  * Default initializer.
30  * @param fileName The name of the file to store the date information.
31  * exist, it will be created if needed.
32  */
33 - (instancetype)initWithFileName:(NSString *)fileName;
34
35 /**
36  * Reads the date from the specified file for the given tag.
37  * @return Returns date if exists, otherwise `nil`.
38  */
39 - (nullable NSDate *)heartbeatDateForTag:(NSString *)tag;
40
41 /**
42  * Saves the date for the specified tag in the specified file.
43  * @return YES on success, NO otherwise.
44  */
45 - (BOOL)setHearbeatDate:(NSDate *)date forTag:(NSString *)tag;
46
47 @end
48
49 NS_ASSUME_NONNULL_END