Bold360 and BoldChat Developer Center

<BCChatViewLogicEvents> Protocol Reference

Event handler protocol of chat view. More...

#import <BCChatViewLogic.h>

Inheritance diagram for <BCChatViewLogicEvents>:
BoldChatChatViewEventHandler

Instance Methods

(void) - bcChatViewLogicChatDidStart:
 Showing the chat view did start. More...
 
(void) - bcChatViewLogicChatDidConnect:
 The chat connected, sending and receiving messages can begin. More...
 
(void) - bcChatViewLogic:chatDidEndAt:text:
 The chat did end. It could have been initiated by the operator, the system, or by a network error. If the visitor initiates the chat finish, the chat view is hidden automatically. More...
 
(void) - bcChatViewLogic:visitorDidSendMessage:
 The visitor added a message, and the message was sent to the server. More...
 
(void) - bcChatViewLogic:messageDidArriveToChatHistory:
 An operator, visitor or system message arrived form the server. It can be also a message that was sent from the current visitor. More...
 
(void) - bcChatViewLogic:autoMessageDidArriveToChatHistory:
 An auto message arrived from the server. More...
 
(void) - bcChatViewLogic:typersDidChangeWithTypers:messageFormat:
 The list of typing operators changed. More...
 
(void) - bcChatViewLogic:operatorIsBusyQueuePosition:messageFormat:unavailableFormAvailable:
 A notification for operator busy. The position in the operator's queue, and if an unavailable form is available is also given. More...
 
(void) - bcChatViewLogicLocalisationChanged:
 The language for the chat is set or changed. More...
 
(void) - bcChatViewLogicViewDidLoad:
 The chat view did load. Additional initializations can be placed here. More...
 
(void) - bcChatViewLogic:textInputDidChangeWithTranslucentTop:translucentBottom:
 The text in the input text view changed. More...
 
(void) - bcChatViewLogic:didChangeLayoutWithTranslucentTop:translucentBottom:
 The layout of the chat view changed. More...
 
(void) - bcChatViewLogicWillCleanUp:
 The views will be deallocated, remove all KVOs and perform custom deinitializations. More...
 

Detailed Description

Event handler protocol of chat view.

It is protocol for events that happen in the chat view logic and modify it dynamically. Custom chat view behavior can be implemented by these callbacks.

Since
Version 1.0

Method Documentation

- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
autoMessageDidArriveToChatHistory: (BCMessage *)  message 

An auto message arrived from the server.

Parameters
chatViewLogicThe chat view logic that reports this event.
messageThe message to be displayed.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
chatDidEndAt: (NSDate *)  endTime
text: (NSString *)  text 

The chat did end. It could have been initiated by the operator, the system, or by a network error. If the visitor initiates the chat finish, the chat view is hidden automatically.

Parameters
chatViewLogicThe chat view logic that reports this event.
endTimeThe chat finish time.
textThe text to be written stating the reason of the chat finish.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
didChangeLayoutWithTranslucentTop: (CGFloat)  top
translucentBottom: (CGFloat)  bottom 

The layout of the chat view changed.

Parameters
chatViewLogicThe chat view logic that reports this event.
topIf the view stretches under a translucent navigation bar this value gives the height of that header.
bottomIf the view stretches under a translucent tab bar, it gives the height of that bar.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
messageDidArriveToChatHistory: (BCMessage *)  message 

An operator, visitor or system message arrived form the server. It can be also a message that was sent from the current visitor.

Parameters
chatViewLogicThe chat view logic that reports this event.
messageThe message to be displayed.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
operatorIsBusyQueuePosition: (NSInteger)  queuePosition
messageFormat: (NSString *)  messageFormat
unavailableFormAvailable: (BOOL)  unavailableFormAvailable 

A notification for operator busy. The position in the operator's queue, and if an unavailable form is available is also given.

Parameters
chatViewLogicThe chat view logic that reports this event.
queuePositionThe position in the queue.
messageFormatThe message that the operator names can be placed into.
unavailableFormAvailableUnavailable chat form is available for the user if he or she does not want to wait for an operator.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
textInputDidChangeWithTranslucentTop: (CGFloat)  top
translucentBottom: (CGFloat)  bottom 

The text in the input text view changed.

Parameters
chatViewLogicThe chat view logic that reports this event.
topIf the view stretches under a translucent navigation bar this value gives the height of that header.
bottomIf the view stretches under a translucent tab bar, it gives the height of that bar.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
typersDidChangeWithTypers: (NSArray *)  typers
messageFormat: (NSString *)  messageFormat 

The list of typing operators changed.

Parameters
chatViewLogicThe chat view logic that reports this event.
typersThe list of typing operator names.
messageFormatThe message that the operator names can be placed into.
Since
Version 1.0
- (void) bcChatViewLogic: (BCChatViewLogic *)  chatViewLogic
visitorDidSendMessage: (BCMessage *)  message 

The visitor added a message, and the message was sent to the server.

Parameters
chatViewLogicThe chat view logic that reports this event.
messageThe message to be displayed.
Since
Version 1.0
- (void) bcChatViewLogicChatDidConnect: (BCChatViewLogic *)  chatViewLogic

The chat connected, sending and receiving messages can begin.

Parameters
chatViewLogicThe chat view logic that reports this event.
Since
Version 1.0
- (void) bcChatViewLogicChatDidStart: (BCChatViewLogic *)  chatViewLogic

Showing the chat view did start.

Parameters
chatViewLogicThe chat view logic that reports this event.
Since
Version 1.0
- (void) bcChatViewLogicLocalisationChanged: (BCChatViewLogic *)  chatViewLogic

The language for the chat is set or changed.

Parameters
chatViewLogicThe chat view logic that reports this event.
Since
Version 1.0
- (void) bcChatViewLogicViewDidLoad: (BCChatViewLogic *)  chatViewLogic

The chat view did load. Additional initializations can be placed here.

Parameters
chatViewLogicThe chat view logic that reports this event.
Since
Version 1.0
- (void) bcChatViewLogicWillCleanUp: (BCChatViewLogic *)  chatViewLogic

The views will be deallocated, remove all KVOs and perform custom deinitializations.

Parameters
chatViewLogicThe chat view logic that reports this event.
Since
Version 1.0

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