A single view controller that implements the whole process of chatting with an operator through BoldChat.
More...
#import <BoldChatViewController.h>
A single view controller that implements the whole process of chatting with an operator through BoldChat.
This is a view controller that guides through the chatting process. It can be created from code with BoldChatViewController::initWithAccountSettings:viewSettings:language: .
It can also be added to a storyboard, but the BoldChatViewController::configureWithAccountSettings:viewSettings:language: needs to be called on the segue that initializes it.
When initialized it has an accountSettings and a viewSettings parameter. The accountSettings need to be filled at least with a valid BCAccount. The viewSettings contains the user interface customizations.
If (BoldChatViewSettings.formSubmitStyle == BoldChatViewSettingsFormSubmitStyleLastCell && BoldChatViewSettings.endChatStyle == BoldChatViewSettingsEndChatStyleOnChatView) there is no need to have a navigation controller around it. If no, a navigation controller needs contain it it to be able to use the right and left navigation button.
- Since
- Version 1.0
Configuration that needs to be called in [UIViewController prepareForSegue:sender:] if initialized on a StoryBoard.
- Parameters
-
| accountSettings | The account settings. |
| viewSettings | The view settings. |
| language | The language. |
- Since
- Version 1.0
| - (IBAction) endExternalActionButtonPressed |
|
|
|
IBAction for endExternalActionButton.
If called, boldChatViewControllerEndExternalActionPressed: is called on the externalEvents .
- Since
- Version 1.0
| - (IBAction) errorExternalActionButtonPressed |
|
|
|
IBAction for errorExternalActionButton.
If called, boldChatViewControllerErrorExternalActionPressed: is called on the externalEvents .
- Since
- Version 1.0
The constructor if initialized from code.
- Parameters
-
| accountSettings | The accountSettings. |
| viewSettings | The view settings. |
| language | The language. |
- Returns
- An instance of BoldChatViewController.
- Since
- Version 1.0
| - (IBAction) mainExternalActionButtonPressed |
|
|
|
IBAction for mainExternalActionButton.
If called, boldChatViewControllerMainExternalActionPressed: is called on the externalEvents .
- Since
- Version 1.0
| - (void) resignContainedFirstResponder |
|
|
|
Hides the keyboarded if it is presented by any of the view controller's subviews.
- Since
- Version 1.0
| - (void) sendMessageText: |
|
(NSString *) |
message |
|
Send a visitor message.
- Since
- Version 1.0
| - (void) sendMessageTyping: |
|
(BOOL) |
typing |
|
Send if the visitor is typing.
- Since
- Version 1.0
Start the chat process. It starts with creating the chat. If the view controller is created and presented, this needs to be called.
- Since
- Version 1.0
Starts the chatting with showing the loading view and waiting for secure parameters. If a secure chat is to be started, start it with calling this selector. It shows the loading view while continueWithSecureParams: is not called and the pre chat form or the chat did not arrive.
- Returns
- A class implementing BoldChatSecureParamsProvider protocol. It is for providing the secure parameters and continuing creating the chat session.
- Since
- Version 1.1
Stop and finish the chat. It can be called anytime.
- Since
- Version 1.0
| - (IBAction) submitFormOrEndChat |
|
|
|
Depending on the view state it submits the currently shown pre, post or unavailable chat, or ends the ongoing chat.
- Since
- Version 1.1
The BoldChat account related settings for the chat.
- Since
- Version 1.0
| - (IBOutlet UIView*) chatHolderView |
|
readwritenonatomicstrong |
The view that holds the chat view.
- Since
- Version 1.0
The delegate.
- Since
- Version 1.0
| - (UIButton*) endExternalActionButton |
|
readwritenonatomicstrong |
| - (IBOutlet UILabel*) endLabel |
|
readwritenonatomicstrong |
The end text label.
- Since
- Version 1.0
| - (IBOutlet UIView*) endView |
|
readwritenonatomicstrong |
The end view shown when the chat session ended.
- Since
- Version 1.0
| - (UIButton*) errorExternalActionButton |
|
readwritenonatomicstrong |
| - (IBOutlet UILabel*) errorLabel |
|
readwritenonatomicstrong |
The error text label.
- Since
- Version 1.0
| - (IBOutlet UIView*) errorView |
|
readwritenonatomicstrong |
The error view shown if there is an error.
- Since
- Version 1.0
The external event callbacks.
- Since
- Version 1.0
| - (BOOL) handleKeyboardEvents |
|
readwritenonatomicassign |
If set the UI changes on keyboard showing/dismissal. Default: YES.
- Since
- Version 1.0
| - (BOOL) handlesApplicationLifecycle |
|
readwritenonatomicassign |
If YES it handles the application going background and foreground events. Default: YES.
- Since
- Version 1.0
The language of the chat.
- Since
- Version 1.0
| - (IBOutlet UIActivityIndicatorView*) loadingActivityIndicator |
|
readwritenonatomicstrong |
The loading activity indicator view.
- Since
- Version 1.0
| - (IBOutlet UIView*) loadingView |
|
readwritenonatomicstrong |
The loading view shown as an overlay when there is an ongoing remote request.
- Since
- Version 1.0
| - (UIButton*) mainExternalActionButton |
|
readwritenonatomicstrong |
| - (IBOutlet UIView*) postChatHolderView |
|
readwritenonatomicstrong |
The view that holds the post chat form.
- Since
- Version 1.0
| - (IBOutlet UIView*) preChatHolderView |
|
readwritenonatomicstrong |
The view that holds the pre chat form.
- Since
- Version 1.0
| - (IBOutlet UIView*) unavailableChatHolderView |
|
readwritenonatomicstrong |
The view that holds the unavailable chat form.
- Since
- Version 1.0
The view customizations.
- Since
- Version 1.0
The documentation for this class was generated from the following file:
