Bold360 and BoldChat Developer Center

<BCChat> Protocol Reference

A protocol of an object that sends and receives chat messages, states and events. More...

#import <BCChat.h>

Inheritance diagram for <BCChat>:

Instance Methods

(void) - addChatTyperDelegate:
 Add a chat type delegate. Multiple delegates are enabled. More...
 
(void) - removeChatTyperDelegate:
 Remove a chat type delegate. More...
 
(void) - addChatMessageDelegate:
 Add a chat message delegate. Multiple delegates are enabled. More...
 
(void) - removeChatMessageDelegate:
 Remove a chat message delegate. More...
 
(void) - addChatQueueDelegate:
 Add a chat queue delegate. Multiple delegates are enabled. More...
 
(void) - removeChatQueueDelegate:
 Remove a chat queue delegate. More...
 
(void) - addChatStateDelegate:
 Add a chat state delegate. Multiple delegates are enabled. More...
 
(void) - removeChatStateDelegate:
 Remove a state type delegate. More...
 
(void) - finishChat
 Finish the chat and answer post chat if available. More...
 
(BOOL) - finishChatToAnswerUnavailableForm
 Finish the chat and gather unavailable chat form to answer it. More...
 
(void) - sendMessage:
 Send a message to the operator. More...
 
(BCMessage *) - sendMessageText:
 Send a message text, to the operator. It is sent with the current visitor settings. More...
 
(void) - sendVisitorTyping:
 Send if the visitor is typing. More...
 

Properties

NSArray * messages
 The list of messages that were sent by the operator and the visitor in timed order. It is an array of BCMessage objects. More...
 
BCMessagecurrentSystemMessage
 The auto or system message for the current state. It can occur if the user started a chat but it was not still answered by any operator. More...
 
BCMessagecurrentAutoMessage
 
long long lastChatMessageId
 The id of the last chat message received from the server. More...
 
BCPersonvisitor
 The current visitor data. More...
 

Detailed Description

A protocol of an object that sends and receives chat messages, states and events.

A chat is a protocol that lets the user to do the actual chatting. It can send messages and can receive messages from the operator. Chats are created on chat session creations when there is no pre chat defined, or on submission of pre chat.

The current chat is returned by BCCreateChatSessionDelegate::bcAccount:didCreateChatWithoutPreChat:andDidStartChat: and bcChatSessionDidSubmitPreChat:andDidStartChat: callbacks. If the chat exists it is also reachable on BCChatSession::chat property.

Since
Version 1.0

Method Documentation

- (void) addChatMessageDelegate: (id< BCChatMessageDelegate >)  delegate

Add a chat message delegate. Multiple delegates are enabled.

Since
Version 1.0
- (void) addChatQueueDelegate: (id< BCChatQueueDelegate >)  delegate

Add a chat queue delegate. Multiple delegates are enabled.

Since
Version 1.0
- (void) addChatStateDelegate: (id< BCChatStateDelegate >)  delegate

Add a chat state delegate. Multiple delegates are enabled.

Since
Version 1.0
- (void) addChatTyperDelegate: (id< BCChatTyperDelegate >)  delegate

Add a chat type delegate. Multiple delegates are enabled.

Since
Version 1.0
- (void) finishChat

Finish the chat and answer post chat if available.

Since
Version 1.0
- (BOOL) finishChatToAnswerUnavailableForm

Finish the chat and gather unavailable chat form to answer it.

Since
Version 1.0
- (void) removeChatMessageDelegate: (id< BCChatMessageDelegate >)  delegate

Remove a chat message delegate.

Since
Version 1.0
- (void) removeChatQueueDelegate: (id< BCChatQueueDelegate >)  delegate

Remove a chat queue delegate.

Since
Version 1.0
- (void) removeChatStateDelegate: (id< BCChatStateDelegate >)  delegate

Remove a state type delegate.

Since
Version 1.0
- (void) removeChatTyperDelegate: (id< BCChatTyperDelegate >)  delegate

Remove a chat type delegate.

Since
Version 1.0
- (void) sendMessage: (BCMessage *)  message

Send a message to the operator.

Parameters
messageThe message to be sent.
Since
Version 1.0
- (BCMessage *) sendMessageText: (NSString *)  messageText

Send a message text, to the operator. It is sent with the current visitor settings.

Parameters
messageTextThe string value of the message to be sent.
Returns
The message object that is actually sent.
Since
Version 1.0
- (void) sendVisitorTyping: (BOOL)  visitorTyping

Send if the visitor is typing.

Parameters
visitorTypingThe visitor's current typing state.
Since
Version 1.0

Property Documentation

- (BCMessage*) currentAutoMessage
readnonatomicassign

The currently active automatic message.

Since
Version 1.1
- (BCMessage*) currentSystemMessage
readnonatomicassign

The auto or system message for the current state. It can occur if the user started a chat but it was not still answered by any operator.

Since
Version 1.0
Deprecated:
System messages are part of normal chat flow. Auto messages have a currently active one now.
- (long long) lastChatMessageId
readnonatomicassign

The id of the last chat message received from the server.

Since
Version 1.0
- (NSArray*) messages
readnonatomicassign

The list of messages that were sent by the operator and the visitor in timed order. It is an array of BCMessage objects.

Since
Version 1.0
- (BCPerson*) visitor
readnonatomicassign

The current visitor data.

Since
Version 1.0

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