Bold360 and BoldChat Developer Center

<BoldChatViewControllerDelegate> Protocol Reference

The delegate of the BoldChatViewController. Lifecycle events of the chat are called back on it. More...

#import <BoldChatViewController.h>

Inheritance diagram for <BoldChatViewControllerDelegate>:

Instance Methods

(void) - boldChatViewControllerChatSessionDidStart:visitorId:language:
 The chat session did start. It means that a pre chat form, an unavailable chat form, or a chat is shown. More...
 
(void) - boldChatViewControllerChatSessionDidFinish:
 The chat session did finish successfully. More...
 
(void) - boldChatViewControllerChatDidStart:
 The chat did start. More...
 
(void) - boldChatViewControllerChatDidFinish:
 The chat did finish successfully. More...
 
(void) - boldChatViewController:chatMessageDidArrive:
 A chat message did arrive. More...
 
(void) - boldChatViewController:chatAutoMessageDidArrive:
 A chat auto message did arrive. More...
 
(void) - boldChatViewController:operatorTyping:
 An operator is typing. More...
 
(void) - boldChatViewController:didChangeLanguageTo:branding:
 The language was changed. More...
 
(void) - boldChatViewController:didFailWithError:
 An error happened in the chat. More...
 

Detailed Description

The delegate of the BoldChatViewController. Lifecycle events of the chat are called back on it.

Since
Version 1.0

Method Documentation

- (void) boldChatViewController: (BoldChatViewController *)  boldChatViewController
chatAutoMessageDidArrive: (BCMessage *)  message 
optional

A chat auto message did arrive.

Parameters
boldChatViewControllerThe view controller that reports the event.
messageThe auto message that arrived.
Since
Version 1.0
- (void) boldChatViewController: (BoldChatViewController *)  boldChatViewController
chatMessageDidArrive: (BCMessage *)  message 
optional

A chat message did arrive.

Parameters
boldChatViewControllerThe view controller that reports the event.
messageThe message that arrived. It can also be a visitor message sent previously.
Since
Version 1.0
- (void) boldChatViewController: (BoldChatViewController *)  boldChatViewController
didChangeLanguageTo: (NSString *)  language
branding: (NSDictionary *)  branding 
optional

The language was changed.

Parameters
boldChatViewControllerThe view controller that reports the event.
languageThe language that the chat was changed to.
brandingThe branding dictionary of the selected language.
Since
Version 1.0
- (void) boldChatViewController: (BoldChatViewController *)  boldChatViewController
didFailWithError: (NSError *)  error 
optional

An error happened in the chat.

Parameters
boldChatViewControllerThe view controller that reports the event.
errorThe error description about the failure. Check error.code with BCErrorCodes.h to get the exact error.
Since
Version 1.0
- (void) boldChatViewController: (BoldChatViewController *)  boldChatViewController
operatorTyping: (BOOL)  typing 
optional

An operator is typing.

Parameters
boldChatViewControllerThe view controller that reports the event.
typingIf YES at least one operator is typing. If NO, no operator is typing.
Since
Version 1.0
- (void) boldChatViewControllerChatDidFinish: (BoldChatViewController *)  boldChatViewController
optional

The chat did finish successfully.

Parameters
boldChatViewControllerThe view controller that reports the event.
Since
Version 1.0
- (void) boldChatViewControllerChatDidStart: (BoldChatViewController *)  boldChatViewController
optional

The chat did start.

Parameters
boldChatViewControllerThe view controller that reports the event.
Since
Version 1.0
- (void) boldChatViewControllerChatSessionDidFinish: (BoldChatViewController *)  boldChatViewController
optional

The chat session did finish successfully.

Parameters
boldChatViewControllerThe view controller that reports the event.
Since
Version 1.0
- (void) boldChatViewControllerChatSessionDidStart: (BoldChatViewController *)  boldChatViewController
visitorId: (NSString *)  visitorId
language: (NSString *)  language 
optional

The chat session did start. It means that a pre chat form, an unavailable chat form, or a chat is shown.

Parameters
boldChatViewControllerThe view controller that reports the event.
visitorIdThe visitor ID of the visitor, which was pre defined, or assigned by the server.
languageThe language of the chat created.
Since
Version 1.0

The documentation for this protocol was generated from the following file: