| 1 |
efrain |
1 |
// Copyright 2020 Google LLC
|
|
|
2 |
//
|
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
|
5 |
// You may obtain a copy of the License at
|
|
|
6 |
//
|
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
8 |
//
|
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
12 |
// See the License for the specific language governing permissions and
|
|
|
13 |
// limitations under the License.
|
|
|
14 |
|
|
|
15 |
#import <Foundation/Foundation.h>
|
|
|
16 |
|
|
|
17 |
/* List of options the session cares about. */
|
|
|
18 |
typedef NS_OPTIONS(NSUInteger, FPRSessionOptions) {
|
|
|
19 |
FPRSessionOptionsNone = 0,
|
|
|
20 |
FPRSessionOptionsGauges = (1 << 0),
|
|
|
21 |
FPRSessionOptionsEvents = (1 << 1),
|
|
|
22 |
};
|
|
|
23 |
|
|
|
24 |
/* Class that contains the details of a session including the sessionId and session options. */
|
|
|
25 |
@interface FPRSessionDetails : NSObject
|
|
|
26 |
|
|
|
27 |
/* The sessionId with which the session details is initialized with. */
|
|
|
28 |
@property(nonatomic, nonnull, readonly) NSString *sessionId;
|
|
|
29 |
|
|
|
30 |
/* List of options enabled for the session. */
|
|
|
31 |
@property(nonatomic, readonly) FPRSessionOptions options;
|
|
|
32 |
|
|
|
33 |
/* Length of the session in minutes. */
|
|
|
34 |
@property(nonatomic, readonly) NSUInteger sessionLengthInMinutes;
|
|
|
35 |
|
|
|
36 |
/**
|
|
|
37 |
* Creates an instance of FPRSessionDetails with the provided sessionId and the list of available
|
|
|
38 |
* options.
|
|
|
39 |
*
|
|
|
40 |
* @param sessionId Session Id for which the object is created.
|
|
|
41 |
* @param options Options enabled for the session.
|
|
|
42 |
* @return Instance of the object FPRSessionDetails.
|
|
|
43 |
*/
|
|
|
44 |
- (nonnull instancetype)initWithSessionId:(nonnull NSString *)sessionId
|
|
|
45 |
options:(FPRSessionOptions)options NS_DESIGNATED_INITIALIZER;
|
|
|
46 |
|
|
|
47 |
- (nullable instancetype)init NS_UNAVAILABLE;
|
|
|
48 |
|
|
|
49 |
/**
|
|
|
50 |
* Checks and returns if the session is verbose.
|
|
|
51 |
*
|
|
|
52 |
* @return Return YES if verbose, NO otherwise.
|
|
|
53 |
*/
|
|
|
54 |
- (BOOL)isVerbose;
|
|
|
55 |
|
|
|
56 |
@end
|