Avaya Client Services API Reference (iOS)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSChatDelegate> Protocol Reference

Chat delegate provides updates about the status of chat. More...

`#import <CSChat.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - chatDidReportServiceAvailable:
| Called when the chat session started and became available. More...
(void) | - chatDidReportServiceUnavailable:
| Called when the chat became unavailable what can be caused by network disruption. More...
(void) | - chat:didReceiveMessage:
| Reports that chat received message. More...
(void) | - chat:allMessagesDidChange:changedMessages:
| Sent to report that the list of messages in the chat has changed. More...
(void) | - chat:publicMessagesDidChange:changedMessages:
| Sent to report that the list of public messages in the chat has changed. More...
(void) | - chat:privateMessagesDidChange:changedMessages:
| Sent to report that the list of private messages in the chat has changed. More...

## Detailed Description

Chat delegate provides updates about the status of chat.

The client application is notified about status updates reported by the server through the CSChatDelegate object. These updates may be the result of local operations on the CSChat object as well as remote changes initiated by either the server or other users on the conference call.

See also
  CSChat::delegate

## Method Documentation

- (void) chat: |  | (CSChat *) | chat
allMessagesDidChange: |  | (CSDataCollectionChangeType) | changeType
changedMessages: |  | (NSArray *) | changedMessages
| optional

Sent to report that the list of messages in the chat has changed.

Parameters

  chat | The chat sending the message.
  changeType | The type of change that has occurred to the message list.
  changedMessages | An array of CSChatMessage objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSChat::allMessages

- (void) chat: |  | (CSChat *) | chat
didReceiveMessage: |  | (CSChatMessage *) | message
| optional

Reports that chat received message.

Method is deprecated. Use other CSChatDelegate method notifying about received messages.

See also
  - chat:allMessagesDidChange:changedMessages:
  - chat:publicMessagesDidChange:changedMessages:
  - chat:privateMessagesDidChange:changedMessages:

- (void) chat: |  | (CSChat *) | chat
privateMessagesDidChange: |  | (CSDataCollectionChangeType) | changeType
changedMessages: |  | (NSArray *) | changedMessages
| optional

Sent to report that the list of private messages in the chat has changed.

Parameters

  chat | The chat sending the message.
  changeType | The type of change that has occurred to the message list.
  changedMessages | An array of CSChatMessage objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSChat::privateMessages

- (void) chat: |  | (CSChat *) | chat
publicMessagesDidChange: |  | (CSDataCollectionChangeType) | changeType
changedMessages: |  | (NSArray *) | changedMessages
| optional

Sent to report that the list of public messages in the chat has changed.

Parameters

  chat | The chat sending the message.
  changeType | The type of change that has occurred to the message list.
  changedMessages | An array of CSChatMessage objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSChat::publicMessages

- (void) chatDidReportServiceAvailable: |  | (CSChat *) | chat |

Called when the chat session started and became available.

Chat can become available/unavailable in case of network disruptions within one call.

Parameters

  chat | The chat sending the message.

See also
  CSChat::chatDidReportServiceUnavailable:

- (void) chatDidReportServiceUnavailable: |  | (CSChat *) | chat |

Called when the chat became unavailable what can be caused by network disruption.

It doesn't mean that chat session has ended.

Parameters

  chat | The chat sending the message.

See also
  CSChat::chatDidReportServiceAvailable:

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

- CSChat.h