lpw
2023-06-03 aca600212ff84587e15aad341babd5eb2faf69a5
commit | author | age
df1e8e 1 /*
L 2  * Copyright 2021 Google LLC
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 #import "GULHeartbeatDateStorable.h"
20
21 NS_ASSUME_NONNULL_BEGIN
22
23 /// Stores either a date or a dictionary to a specified file.
24 @interface GULHeartbeatDateStorageUserDefaults : NSObject <GULHeartbeatDateStorable>
25
26 /**
27  * Default initializer. tvOS can only write to the cache directory and
28  * there are no guarantees that the directory will persist. User defaults will
29  * be retained, so that should be used instead.
30  * @param defaults User defaults instance to store the heartbeat information.
31  * @param key The key to be used with the user defaults instance.
32  */
33 - (instancetype)initWithDefaults:(NSUserDefaults *)defaults key:(NSString *)key;
34
35 - (instancetype)init NS_UNAVAILABLE;
36
37 /**
38  * Reads the date from the specified file for the given tag.
39  * @return Returns date if exists, otherwise `nil`.
40  */
41 - (nullable NSDate *)heartbeatDateForTag:(NSString *)tag;
42
43 /**
44  * Saves the date for the specified tag in the specified file.
45  * @return YES on success, NO otherwise.
46  */
47 - (BOOL)setHearbeatDate:(NSDate *)date forTag:(NSString *)tag;
48
49 @end
50
51 NS_ASSUME_NONNULL_END