Represents a chat within the Interaction Center system.
Namespace: ININ.IceLib.InteractionsAssembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public class ChatInteraction : Interaction |
Visual Basic |
---|
Public Class ChatInteraction _ Inherits Interaction |
Remarks
Chat interactions allow users to interact by sending and receiving text, files, or URLs.
- To start watching a chat interaction call ChatStartWatching()()()() or
ChatStartWatchingAsync(AsyncCompletedEventHandler, Object). When the asynchronous chat start watch completes it invokes the
completedCallback delegate.
- To stop watching a chat interaction call ChatStopWatching()()()() or
ChatStopWatchingAsync(AsyncCompletedEventHandler, Object). When the asynchronous chat stop watch completes, it invokes the
completedCallback delegate.
- To add members to the chat call AddMembers(array<InteractionId>[]()[][]) or AddMembersAsync(array<InteractionId>[]()[][], AsyncCompletedEventHandler, Object) providing an
array of InteractionId for all members to add to this chat. When the asynchronous add members
operation completes it invokes the completedCallback delegate.
- To set an indicator to the members that a member is typing call the
SetTypingIndicator(Boolean) or SetTypingIndicatorAsync(Boolean, AsyncCompletedEventHandler, Object) providing a flag
to indicate if the typing indicator is visible or not. When the asynchronous set typing indicator
operation completes it invokes the completedCallback delegate.
- To send text to members of this chat, call the SendText(String) or
SendTextAsync(String, AsyncCompletedEventHandler, Object) methods with the text to send. When the asynchronous send text
operation completes it invokes the completedCallback delegate.
- To send a URL to the chat members, call the SendUrl(Uri) or SendUrlAsync(Uri, AsyncCompletedEventHandler, Object)
methods. When the asynchronous send URL operation completes it invokes the completedCallback delegate.
- To send a file to chat members call SendFile(String) or SendFileAsync(String, AsyncCompletedEventHandler, Object). When the
asynchronous send file operation completes it invokes the completedCallback delegate.
- Calling ChatStartWatching or ChatStartWatchingAsync when a watch is already
in place, or calling ChatStopWatching or ChatStartWatchingAsync when a watch is
not in place raises an InvalidOperationException.
Note |
---|
The asynchronous versions of the above methods are preferred since they can be lengthy operations. |
Inheritance Hierarchy
System..::..Object
ININ.IceLib.Interactions..::..Interaction
ININ.IceLib.Interactions..::..ChatInteraction
ININ.IceLib.Interactions..::..Interaction
ININ.IceLib.Interactions..::..ChatInteraction
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.