mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
72 lines
2.3 KiB
Objective-C
72 lines
2.3 KiB
Objective-C
|
/*
|
||
|
|
* Copyright 2017 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>
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_BEGIN
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An FSTTimestamp represents an absolute time from the backend at up to nanosecond precision.
|
||
|
|
* An FSTTimestamp is represented in terms of UTC and does not have an associated timezone.
|
||
|
|
*/
|
||
|
|
@interface FSTTimestamp : NSObject <NSCopying>
|
||
|
|
|
||
|
|
- (instancetype)init NS_UNAVAILABLE;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new timestamp.
|
||
|
|
*
|
||
|
|
* @param seconds the number of seconds since epoch.
|
||
|
|
* @param nanos the number of nanoseconds after the seconds.
|
||
|
|
*/
|
||
|
|
- (instancetype)initWithSeconds:(int64_t)seconds nanos:(int32_t)nanos NS_DESIGNATED_INITIALIZER;
|
||
|
|
|
||
|
|
/** Creates a new timestamp with the current date / time. */
|
||
|
|
+ (instancetype)timestamp;
|
||
|
|
|
||
|
|
/** Creates a new timestamp from the given date. */
|
||
|
|
+ (instancetype)timestampWithDate:(NSDate *)date;
|
||
|
|
|
||
|
|
/** Returns a new NSDate corresponding to this timestamp. This may lose precision. */
|
||
|
|
- (NSDate *)approximateDateValue;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Converts the given date to a an ISO 8601 timestamp string, useful for rendering in JSON.
|
||
|
|
*
|
||
|
|
* ISO 8601 dates times in UTC look like this: "1912-04-14T23:40:00.000000000Z".
|
||
|
|
*
|
||
|
|
* @see http://www.ecma-international.org/ecma-262/6.0/#sec-date-time-string-format
|
||
|
|
*/
|
||
|
|
- (NSString *)ISO8601String;
|
||
|
|
|
||
|
|
- (NSComparisonResult)compare:(FSTTimestamp *)other;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z.
|
||
|
|
* Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
|
||
|
|
*/
|
||
|
|
@property(nonatomic, assign, readonly) int64_t seconds;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Non-negative fractions of a second at nanosecond resolution. Negative second values with
|
||
|
|
* fractions must still have non-negative nanos values that count forward in time.
|
||
|
|
* Must be from 0 to 999,999,999 inclusive.
|
||
|
|
*/
|
||
|
|
@property(nonatomic, assign, readonly) int32_t nanos;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_END
|