added the documentation for QMInputToolbar

Author: Vitaliy G

QMChatViewController/QMChatViewController.m

@@ -88,7 +88,7 @@ - (void)viewDidLoad {
     //Customize your toolbar buttons
     self.inputToolbar.contentView.leftBarButtonItem = [self accessoryButtonItem];
     self.inputToolbar.contentView.rightBarButtonItem = [self sendButtonItem];
-    self.inputToolbar.audioRecordingIsEnabled = YES;
+    self.inputToolbar.audioRecordingEnabled = YES;
 
     __weak __typeof(self) weakSelf = self;
     self.systemInputToolbar = [[QMKVOView alloc] init];

QMChatViewController/Views/CustomUI/InputToolBar/QMInputToolbar.h

@@ -41,13 +41,56 @@
 
 @optional
 
-- (BOOL)messagesInputToolbarAudioRecordingEnabled:(QMInputToolbar *)toolbar;
+/**
+ Asks the delegate if it can start the audio recording by touching the audio record button.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ @return YES if the audio recording should start or NO if it should not.
+ */
+- (BOOL)messagesInputToolbarAudioRecordingShouldStart:(QMInputToolbar *)toolbar;
+
+/**
+ This method is called when an audio recording has started.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ */
 - (void)messagesInputToolbarAudioRecordingStart:(QMInputToolbar *)toolbar;
+
+/**
+ This method is called when an audio recording has cancelled.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ */
 - (void)messagesInputToolbarAudioRecordingCancel:(QMInputToolbar *)toolbar;
+
+/**
+ This method is called when an audio recording has completed.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ */
 - (void)messagesInputToolbarAudioRecordingComplete:(QMInputToolbar *)toolbar;
+
+/**
+ This method is called when an audio recording has paused because of timeout.
+ @discussion: This mehod will be called only if 'inputPanelAudioRecordingMaximumDuration:' is adopted.
+ @param toolbar An instance of `QBChatMessageInputToolbar`.
+ */
 - (void)messagesInputToolbarAudioRecordingPausedByTimeOut:(QMInputToolbar *)toolbar;
 
+/**
+ Tells the delegate to return the current duration.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ @return Current duration of the audio recorder.
+ */
 - (NSTimeInterval)inputPanelAudioRecordingDuration:(QMInputToolbar *)toolbar;
+
+/**
+ Tells the delegate to return the maximum duration.
+ 
+ @param toolbar An instance of `QBChatMessageInputToolbar`
+ @return The maximum duration of the recorded audio.
+ */
 - (NSTimeInterval)inputPanelAudioRecordingMaximumDuration:(QMInputToolbar *)toolbar;
 
 @end
@@ -102,11 +145,22 @@
  */
 - (QMToolbarContentView *)loadToolbarContentView;
 
-@property (assign, nonatomic) BOOL audioRecordingIsEnabled;
+/**
+ Enables ability to record and send audio attachments.
+ @default NO
+ @discussion: If YES, the 'audio record' button is enabled on the 'send button' side.
+ @warning: Methods of delegate for audio recording should be adopted.
+ */
+@property (assign, nonatomic) BOOL audioRecordingEnabled;
+
+/**
+ Cancels current audio recording and calls the delegate method 'messagesInputToolbarAudioRecordingCancel:'
+ */
+- (void)cancelAudioRecording;
 
-- (void)startAudioRecording;
-- (void)finishAudioRecording;
-- (void)forceFinishRecording;
+/**
+ Performs the shake animation for audio record button.
+ */
 - (void)shakeControls;
 
 @end

QMChatViewController/Views/CustomUI/InputToolBar/QMInputToolbar.m

@@ -51,11 +51,10 @@ - (instancetype)init {
     return self;
 }
 
-- (void)setAudioRecordingIsEnabled:(BOOL)audioRecordingIsEnabled {
+- (void)setAudioRecordingEnabled:(BOOL)audioRecordingEnabled {
 
-    if (_audioRecordingIsEnabled != audioRecordingIsEnabled) {
-        
-        _audioRecordingIsEnabled = audioRecordingIsEnabled;
+    if (_audioRecordingEnabled != audioRecordingEnabled) {
+        _audioRecordingEnabled = audioRecordingEnabled;
         [self toggleSendButtonEnabled];
     }
 }
@@ -126,28 +125,26 @@ - (void)toggleButtons {
     BOOL hasTextAttachment = [self.contentView.textView hasTextAttachment];
     BOOL hasDataToSend = hasText || hasTextAttachment;
 
+    UIButton *buttonToUpdate;
+    UIView *buttonContainer;
     if (self.sendButtonOnRight) {
-        
-        self.contentView.rightBarButtonItem.hidden = !hasDataToSend;
-        self.contentView.rightBarButtonItem.enabled = [self.contentView.textView hasText];
-        
-        if (!self.audioRecordButtonItem.superview) {
-            [self.contentView.rightBarButtonContainerView addSubview:[self audioRecordButtonItem]];
-            
-            [self audioRecordButtonItem].translatesAutoresizingMaskIntoConstraints = false;
-            [self addCenterConstraintsToItem:self.contentView.rightBarButtonContainerView];
-        }
+        buttonToUpdate = self.contentView.rightBarButtonItem;
+        buttonContainer = self.contentView.rightBarButtonContainerView;
     }
     else {
+        buttonToUpdate = self.contentView.leftBarButtonItem;
+        buttonContainer = self.contentView.leftBarButtonContainerView;
+    }
+    
+    buttonToUpdate.hidden = !hasDataToSend;
+    buttonToUpdate.enabled = [self.contentView.textView hasText];
+    
+    if (!self.audioRecordButtonItem.superview) {
 
-        self.contentView.leftBarButtonItem.hidden = !hasDataToSend;
-        self.contentView.leftBarButtonItem.enabled = [self.contentView.textView hasText];
+        [buttonContainer addSubview:[self audioRecordButtonItem]];
 
-        if (!self.audioRecordButtonItem.superview) {
-            [self.contentView.leftBarButtonContainerView addSubview:[self audioRecordButtonItem]];
-            [self audioRecordButtonItem].translatesAutoresizingMaskIntoConstraints = false;
-            [self addCenterConstraintsToItem:self.contentView.leftBarButtonContainerView];
-        }
+        [self audioRecordButtonItem].translatesAutoresizingMaskIntoConstraints = false;
+        [self addCenterConstraintsToItem:buttonContainer];
     }
 
     self.audioRecordButtonItem.hidden = hasDataToSend;
@@ -174,7 +171,7 @@ - (void)addCenterConstraintsToItem:(UIView *)itemToAdd {
 
 - (void)toggleSendButtonEnabled {
 
-    if (self.audioRecordingIsEnabled) {
+    if (self.audioRecordingEnabled) {
 
         [self toggleButtons];
         return;
@@ -326,7 +323,7 @@ - (void)finishAudioRecording {
 
 - (void)recordButtonInteractionDidBegin {
 
-    if ([self.delegate messagesInputToolbarAudioRecordingEnabled:self]) {
+    if ([self.delegate messagesInputToolbarAudioRecordingShouldStart:self]) {
 
         self.recording = YES;
         [self setShowRecordingInterface:true velocity:0.0f];
@@ -346,7 +343,7 @@ - (void)recordButtonInteractionDidCancel:(CGFloat)velocity {
     }
 }
 
-- (void)forceFinishRecording {
+- (void)cancelAudioRecording {
 
     if (self.isRecording) {
         self.recording = NO;