SCSChatEventDelegate
@protocol SCSChatEventDelegate <NSObject>
The SCSChatEventDelegate
protocol provides general event information about the chat
session. Add your implementation to -[SCSChat addEventDelegate:]
.
See
SCSChat
-
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session agentJoined:(SCSAgentJoinEvent *)agentjoinedEvent;
Parameters
agentjoinedEvent
Info about the agent joining the session.
-
Tells the delegate when an agent has left the group conference.
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session agentLeftConference:(SCSAgentLeftConferenceEvent *)agentLeftConferenceEvent;
Parameters
session
Info about the chat session.
agentLeftConferenceEvent
Info about the agent leaving the session.
-
Tells the delegate when an outgoing message has been processed. This does not guarantee that the message was sent successfully. Inspect the
message
parameter to determine whether the sent message was modified.See
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session processedOutgoingMessage:(SCSUserTextEvent *)message;
Parameters
message
Info about the outgoing message.
-
Tells the delegate that the delivery status of a message has been updated.
See
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didUpdateOutgoingMessageDeliveryStatus:(SCSUserTextEvent *)message;
Parameters
message
Info about the outgoing message.
-
Tells the delegate when the menu item has been selected.
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didSelectMenuItem:(SCSChatMenuSelectionEvent *)menuEvent;
Parameters
menuEvent
Info about the selected menu item.
-
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didReceiveMessage:(SCSAgentTextEvent *)message;
Parameters
message
Info about the incoming message.
-
Tells the delegate when a chatbot menu has been received from the org.
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didReceiveChatBotMenu:(SCSChatBotMenuEvent *)menuEvent;
Parameters
menuEvent
Info about the chatbot menu.
-
Tells the delegate when an agent requests a file transfer.
See
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didReceiveFileTransferRequest:(SCSFileTransferEvent *)fileTransferEvent;
Parameters
fileTransferEvent
Info about the file transfer request.
-
Tells the delegate when a transfer to an agent is initiated.
Declaration
Objective-C
- (void)transferToButtonInitiatedWithSession:(id<SCSChatSession>)session;
Parameters
session
Info about the chat session.
-
Tells the delegate when a transfer to an agent is completed.
Declaration
Objective-C
- (void)transferToButtonCompletedWithSession:(id<SCSChatSession>)session;
Parameters
session
Info about the chat session.
-
Tells the delegate when a transfer to an agent has failed.
Declaration
Objective-C
- (void)transferToButtonFailedWithSession:(id<SCSChatSession>)session error:(NSError *)error;
Parameters
session
Info about the chat session.
error
NSError containing details about the failure.
-
Tells the delegate when an agent begins typing.
Declaration
Objective-C
- (void)agentBeganTypingWithSession:(id<SCSChatSession>)session;
Parameters
session
Info about the chat session.
-
Tells the delegate when an agent finishes typing.
Declaration
Objective-C
- (void)agentFinishedTypingWithSession:(id<SCSChatSession>)session;
Parameters
session
Info about the chat session.
-
Tells the delegate when a URL has been detected in a message.
Declaration
Objective-C
- (void)session:(id<SCSChatSession>)session didReceiveURL:(SCSURLEvent *)urlEvent;
Parameters
urlEvent
Info about the detected URL.