summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLListFilesOperation.h
diff options
context:
space:
mode:
authorJoel Fischer <joeljfischer@gmail.com>2016-08-08 15:38:36 -0400
committerJoel Fischer <joeljfischer@gmail.com>2016-08-08 15:38:36 -0400
commit6073d1a35ae6bdc8c5d52bed106c711e4fe571e7 (patch)
tree98b6eff15103a898ddec619c56a97e093a2ee020 /SmartDeviceLink/SDLListFilesOperation.h
parentef5e8d84ea76257a466b54f5ced200cdddb6cf90 (diff)
downloadsdl_ios-6073d1a35ae6bdc8c5d52bed106c711e4fe571e7.tar.gz
Add a ton of documentation
Diffstat (limited to 'SmartDeviceLink/SDLListFilesOperation.h')
-rw-r--r--SmartDeviceLink/SDLListFilesOperation.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLListFilesOperation.h b/SmartDeviceLink/SDLListFilesOperation.h
index 61818759c..7153504a8 100644
--- a/SmartDeviceLink/SDLListFilesOperation.h
+++ b/SmartDeviceLink/SDLListFilesOperation.h
@@ -16,6 +16,14 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLListFilesOperation : NSOperation
+/**
+ * Create an instance of a list files operation which will ask the remote system which files it has on its system already.
+ *
+ * @param connectionManager The connection manager which will handle transporting the request to the remote system.
+ * @param completionHandler A completion handler for when the response returns.
+ *
+ * @return An instance of SDLListFilesOperation
+ */
- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager completionHandler:(nullable SDLFileManagerListFilesCompletion)completionHandler;
@end