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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
//
// SDLPermissionManager.h
// SmartDeviceLink-iOS
//
// Created by Joel Fischer on 10/14/15.
// Copyright © 2015 smartdevicelink. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SDLHMILevel.h"
#import "SDLPermissionConstants.h"
#import "SDLRPCFunctionNames.h"
#import "SDLRPCPermissionStatus.h"
@class SDLPermissionItem;
@class SDLRPCMessage;
NS_ASSUME_NONNULL_BEGIN
/// The permission manager monitoring RPC permissions.
@interface SDLPermissionManager : NSObject
/**
* Flag indicating if the app requires an encryption service to be active.
*/
@property (assign, nonatomic, readonly) BOOL requiresEncryption;
/**
* Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLPermissionManager, you should use the manager found on `SDLManager`.
*
* @param completionHandler The block to be called when the manager's setup is complete.
*/
- (void)startWithCompletionHandler:(void (^)(BOOL success, NSError *__nullable error))completionHandler;
/**
* Stop the manager. This method is used internally.
*/
- (void)stop;
/**
* Determine if an individual RPC is allowed for the current HMI level
*
* @param rpcName The name of the RPC to be tested, for example, SDLShow
*
* @return YES if the RPC is allowed at the current HMI level, NO if not
*/
- (BOOL)isRPCAllowed:(SDLPermissionRPCName)rpcName __deprecated_msg(("Use isRPCNameAllowed: instead"));
/**
* Determine if an individual RPC is allowed for the current HMI level
*
* @param rpcName The name of the RPC to be tested, for example, SDLRPCFunctionNameShow
*
* @return YES if the RPC is allowed at the current HMI level, NO if not
*/
- (BOOL)isRPCNameAllowed:(SDLRPCFunctionName)rpcName;
/**
* Determine if all RPCs are allowed for the current HMI level
*
* @param rpcNames The RPCs to check
*
* @return AllAllowed if all of the permissions are allowed, AllDisallowed if all the permissions are disallowed, Any if some are allowed, and some are disallowed
*/
- (SDLPermissionGroupStatus)groupStatusOfRPCs:(NSArray<SDLPermissionRPCName> *)rpcNames __deprecated_msg(("Use groupStatusOfRPCNames: instead"));
/**
* Determine if all RPCs are allowed for the current HMI level
*
* @param rpcNames The RPCs to check
*
* @return AllAllowed if all of the permissions are allowed, AllDisallowed if all the permissions are disallowed, Any if some are allowed, and some are disallowed
*/
- (SDLPermissionGroupStatus)groupStatusOfRPCNames:(NSArray<SDLPermissionElement *> *)rpcNames;
/**
* Retrieve a dictionary with keys that are the passed in RPC names, and objects of an NSNumber<BOOL> specifying if that RPC is currently allowed
*
* @param rpcNames An array of RPC names to check
*
* @return A dictionary specifying if the passed in RPC names are currently allowed or not
*/
- (NSDictionary<SDLPermissionRPCName, NSNumber *> *)statusOfRPCs:(NSArray<SDLPermissionRPCName> *)rpcNames __deprecated_msg(("Use statusesOfRPCNames: instead"));
/**
* Retrieve a dictionary with keys that are the passed in RPC names, and objects of an NSNumber<BOOL> specifying if that RPC is currently allowed
*
* @param rpcNames An array of RPC names to check
*
* @return A dictionary specifying if the passed in RPC names are currently allowed or not
*/
- (NSDictionary<SDLRPCFunctionName, SDLRPCPermissionStatus *> *)statusesOfRPCNames:(NSArray<SDLPermissionElement *> *)rpcNames;
/**
* Add an observer for specified RPC names, with a callback that will be called whenever the value changes, as well as immediately with the current status.
*
* @warning This block will be captured by the SDLPermissionsManager, be sure to use [weakself/strongself](http://www.logicsector.com/ios/avoiding-objc-retain-cycles-with-weakself-and-strongself-the-easy-way/) if you are referencing self within your observer block.
*
* @warning The observer may be called before this method returns, do not attempt to remove the observer from within the observer. That could send `nil` to removeObserverForIdentifier:. If you want functionality like that, call groupStatusOfRPCs: instead.
*
* @param rpcNames The RPCs to be observed
* @param groupType Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. The observer is first set regardless of RPC status 2. Every RPC in rpcNames becomes allowed 3. The group of rpcNames goes from all being allowed to some or all being disallowed.
* @param handler The block that will be called whenever permissions change.
*
* @return An identifier that can be passed to removeObserverForIdentifer: to remove the observer
*/
- (SDLPermissionObserverIdentifier)addObserverForRPCs:(NSArray<SDLPermissionRPCName> *)rpcNames groupType:(SDLPermissionGroupType)groupType withHandler:(SDLPermissionsChangedHandler)handler __deprecated_msg(("Use subscribeToRPCNames:groupType:withHandler: instead"));
/**
* Subscribe to specified RPC names, with a callback that will be called whenever the value changes. Unlike addObserverForRPCs:groupType:withHandler:, the callback will only return immediately if the groupType is set to SDLPermissionGroupTypeAny or if the groupType is set to SDLPermissionGroupTypeAllAllowed and all RPCs in the rpcNames parameter are allowed.
*
* @warning The observer may be called before this method returns, do not attempt to remove the observer from within the observer. That could send `nil` to removeObserverForIdentifier:. If you want functionality like that, call groupStatusOfRPCs: instead.
*
* @param rpcNames The RPCs to be observed
* @param groupType Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. Every RPC in rpcNames becomes allowed 2. The group of rpcNames goes from all being allowed to some or all being disallowed.
* @param handler The block that will be called whenever permissions change.
*
* @return An identifier that can be passed to removeObserverForIdentifer: to remove the observer
*/
- (SDLPermissionObserverIdentifier)subscribeToRPCNames:(NSArray<SDLPermissionElement *> *)rpcNames groupType:(SDLPermissionGroupType)groupType withHandler:(SDLRPCPermissionStatusChangedHandler)handler;
/**
* Remove every current observer
*/
- (void)removeAllObservers;
/**
* Remove block observers for the specified RPC
*
* @param identifier The identifier specifying which observer to remove
*/
- (void)removeObserverForIdentifier:(SDLPermissionObserverIdentifier)identifier;
/**
* Check whether or not an RPC needs encryption.
*/
- (BOOL)rpcRequiresEncryption:(SDLPermissionRPCName)rpcName __deprecated_msg(("Use rpcNameRequiresEncryption: instead"));
/**
* Check whether or not an RPC needs encryption.
*/
- (BOOL)rpcNameRequiresEncryption:(SDLRPCFunctionName)rpcName;
/**
* Check whether a parameter of an RPC is allowed
*
* @param rpcName The name of the RPC to be tested, for example, SDLRPCFunctionNameGetVehicleData
*
* @param parameter The name of the parameter to be tested, for example, rpm
*/
- (BOOL)isPermissionParameterAllowed:(SDLRPCFunctionName)rpcName parameter:(NSString*)parameter;
@end
NS_ASSUME_NONNULL_END
|
