diff options
author | NicoleYarroch <nicole@livio.io> | 2020-04-14 15:11:44 -0400 |
---|---|---|
committer | NicoleYarroch <nicole@livio.io> | 2020-04-14 15:11:44 -0400 |
commit | ab7d4480caca30512fd6429a7b75307ffc4e54f9 (patch) | |
tree | 9262ac57f3e8a4c21764cb4592c9d9d9495dfaad | |
parent | ae516457b9ca8520a809653bbe066f4509151cf1 (diff) | |
download | sdl_ios-ab7d4480caca30512fd6429a7b75307ffc4e54f9.tar.gz |
Added documentation for handler’s ret val
-rw-r--r-- | SmartDeviceLink/SDLBackgroundTaskManager.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLBackgroundTaskManager.h b/SmartDeviceLink/SDLBackgroundTaskManager.h index 5c1c7eb57..8a943781a 100644 --- a/SmartDeviceLink/SDLBackgroundTaskManager.h +++ b/SmartDeviceLink/SDLBackgroundTaskManager.h @@ -17,6 +17,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLBackgroundTaskManager : NSObject /// Handler called when the background task is about to expire. Use this handler to perform some cleanup before the background task is destroyed. When you have finished cleanup, you must call the `endBackgroundTask` function so the background task can be destroyed. If you do not call `endBackgroundTask`, the system may kill the app. +/// @return Whether or to wait for the subscriber to cleanup. If NO, the background task will be killed immediately. If YES, the background task will not be destroyed until the `expiredTaskCleanupFinished` method is called. @property (copy, nonatomic, nullable) BOOL (^taskExpiringHandler)(void); - (instancetype)init NS_UNAVAILABLE; |