diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2020-07-24 10:28:58 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-24 10:28:58 -0400 |
commit | 385a3794c73278e84734ba20458ed12ffb7ed6ae (patch) | |
tree | bea6b66f3c3d4fec1d74eea643b461403460deb7 | |
parent | 2cd82975807f5b710c60fad7b4442578043c741c (diff) | |
parent | d362caf5a7c1cac6785d1e6ab7c7335466fa603b (diff) | |
download | sdl_ios-385a3794c73278e84734ba20458ed12ffb7ed6ae.tar.gz |
Merge pull request #1725 from smartdevicelink/bugfix/issue-1724-permission-manager-subscribe-callback-documentation
Fix documentation on permission manager subscribe method callback parameters
-rw-r--r-- | SmartDeviceLink/SDLPermissionConstants.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/SmartDeviceLink/SDLPermissionConstants.h b/SmartDeviceLink/SDLPermissionConstants.h index 2cd9bbc4e..8c7c1f0da 100644 --- a/SmartDeviceLink/SDLPermissionConstants.h +++ b/SmartDeviceLink/SDLPermissionConstants.h @@ -64,17 +64,17 @@ typedef NS_ENUM(NSUInteger, SDLPermissionGroupStatus) { /** * This is a block that is passed in to some methods that will be stored and called when specified permissions change. * - * @param change A dictionary of permission changes containing <key(String): RPC Name, object(BOOL): YES if the RPC is allowed, NO if it is not allowed> - * @param status The unified group status of the RPCs in the change dictionary. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed + * @param updatedPermissionStatuses A dictionary of the new current status of all subscription items; containing <key(String): RPC Name, object(BOOL): YES if the RPC is allowed, NO if it is not allowed> + * @param status The unified group status of the RPCs in the updatedPermissionStatuses dictionary. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed */ -typedef void (^SDLPermissionsChangedHandler)(NSDictionary<SDLPermissionRPCName, NSNumber *> *_Nonnull change, SDLPermissionGroupStatus status); +typedef void (^SDLPermissionsChangedHandler)(NSDictionary<SDLPermissionRPCName, NSNumber *> *_Nonnull updatedPermissionStatuses, SDLPermissionGroupStatus status); /** * A block that will be called when specified permissions change. It will return whether each RPC and its parameters are allowed as well as the permission group status of all the RPCs. * - * @param change A dictionary of permission changes containing <key(String): SDLPermissionRPCName, object(SDLRPCPermissionStatus)> - * @param status The change made to all of the RPCs in the change dictionary. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed + * @param updatedPermissionStatuses A dictionary of the new current status of all subscription items; containing <key(String): SDLPermissionRPCName, object(SDLRPCPermissionStatus)> + * @param status The unified group status of the RPCs in the updatedPermissionStatuses dictionary. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed */ -typedef void (^SDLRPCPermissionStatusChangedHandler)(NSDictionary<SDLRPCFunctionName, SDLRPCPermissionStatus *> *_Nonnull change, SDLPermissionGroupStatus status); +typedef void (^SDLRPCPermissionStatusChangedHandler)(NSDictionary<SDLRPCFunctionName, SDLRPCPermissionStatus *> *_Nonnull updatedPermissionStatuses, SDLPermissionGroupStatus status); NS_ASSUME_NONNULL_END |