| ChatClient Class |
Chat module allows to manage user dialogs.
http://quickblox.com/developers/Chat
Inheritance HierarchyNamespace: Quickblox.Sdk.Modules.ChatModule
Assembly: Quickblox.Sdk.Xamarin (in Quickblox.Sdk.Xamarin.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe ChatClient type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CreateDialogAsync |
Creates a new dialog.
|
| CreateMessageAsync |
Creates a chat message. It’s possible to inject a new chat message to the chat history. In this case this new message won't be delivered to the recipient(s) by XMPP real time transport, it will be just added to the history. If you wont to initiates a real 'send to chat' - pass send_to_chat=1 parameter.
|
| DeleteDialogAsync |
Deletes chat dialog. Each user from dialog’s occupant_ids field can remove the dialog.
This doesn’t mean that this dialog will be removed completely for all the users in this dialog. It will be removed only for current user.
To completely remove a dialog - pass force=1. Only owner can do it.
|
| DeleteMessageAsync |
Any user in the dialog’s occupant_ids is able to remove a message from the dialog. The message will only be removed for the current user - the message will still be viewable and in the chat history for all other users in the dialog.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDialogsAsync |
Returns all dialogs associated with current user
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetMessagesAsync(String) |
Retrieves all chat messages within particular dialog. It's only possible to read chat messages in dialog if current user id is in occupants_ids field or if dialog's type=1(PUBLIC_GROUP). Server will return dialog's chat messages sorted ascending by date_sent field.
All retrieved chat messages will be marked as read after request.
|
| GetMessagesAsync(RetrieveMessagesRequest) |
Retrieves all chat messages within particular dialog. It's only possible to read chat messages in dialog if current user id is in occupants_ids field or if dialog's type=1(PUBLIC_GROUP). Server will return dialog's chat messages sorted ascending by date_sent field.
All retrieved chat messages will be marked as read after request.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateDialogAsync |
Updates a dialog. Works only if type=1(PUBLIC_GROUP) or 2(GROUP).
Users who are in occupants_ids can update a dialog with type=2(GROUP). If type=1(PUBLIC_GROUP) - only dialog’s owner can update it.
|
| UpdateMessageAsync |
Updates a chat message.
It's possible to mark all messages as read/delivered - just don't pass a message id.
|
See Also