CometChatUIKit class

Constructors

CometChatUIKit.new()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

authenticationSettings ↔ UIKitSettings?
getter/setter pair
conversationUpdateSettings ↔ ConversationUpdateSettings?
getter/setter pair
localTimeZoneIdentifier ↔ String
getter/setter pair
localTimeZoneName ↔ String
getter/setter pair
loggedInUser ↔ User?
getter/setter pair
soundManager → SoundManager
soundManager used to play sound
final

Static Methods

addReaction(int messageId, String reaction, {dynamic onSuccess(BaseMessage)?, dynamic onError(CometChatException)?}) → Future<BaseMessage?>
addReaction will add a reaction to a message with the provided message ID and will update the UI of CometChatMessageList and CometChatReactions accordingly
checkAuthSettings(dynamic onError(CometChatException e)?) → bool
createUser(User user, {dynamic onSuccess(User user)?, dynamic onError(CometChatException e)?}) → Future<User?>
Method returns user after creation in cometchat environment
getConversationUpdateSettings() → void
getDataSource() → DataSource
method used to get decorated data source which contains all the extensions logic
getLoggedInUser({dynamic onSuccess(User)?, dynamic onError(CometChatException)?}) → Future<User?>
getLoggedInUser checks if any session is active and retrieves the User data of the logged in user
init({required UIKitSettings uiKitSettings, dynamic onSuccess(String successMessage)?, dynamic onError(CometChatException e)?}) → dynamic
method initializes the settings required for CometChat
login(String uid, {dynamic onSuccess(User user)?, dynamic onError(CometChatException excep)?}) → Future<User?>
Use this function only for testing purpose. For production, use loginWithAuthToken
loginWithAuthToken(String authToken, {dynamic onSuccess(User user)?, dynamic onError(CometChatException excep)?}) → Future<User?>
Returns a User object after login in CometChat API.
logout({dynamic onSuccess(String)?, dynamic onError(CometChatException excep)?}) → dynamic
used to logout user
removeReaction(int messageId, String reaction, {dynamic onSuccess(BaseMessage)?, dynamic onError(CometChatException)?}) → Future<BaseMessage?>
addReaction will remove a reaction to a message with the provided message ID and will update the UI of CometChatMessageList and CometChatReactions accordingly
sendCardMessage(CardMessage message, {dynamic onSuccess(CardMessage)?, dynamic onError(CometChatException)?}) → Future<CardMessage?>
sendFormMessage used to send a custom message
sendCustomMessage(CustomMessage message, {dynamic onSuccess(CustomMessage)?, dynamic onError(CometChatException)?}) → Future<CustomMessage?>
sendCustomMessage used to send a custom message
sendFormMessage(FormMessage message, {dynamic onSuccess(FormMessage)?, dynamic onError(CometChatException)?}) → Future<FormMessage?>
sendFormMessage used to send a custom message
sendMediaMessage(MediaMessage message, {dynamic onSuccess(MediaMessage)?, dynamic onError(CometChatException)?, bool replacePathForIOS = true}) → Future<MediaMessage?>
sendMediaMessage used to send a media message
sendSchedulerMessage(SchedulerMessage message, {dynamic onSuccess(SchedulerMessage)?, dynamic onError(CometChatException)?}) → Future<SchedulerMessage?>
SchedulerMessage used to send a custom message
sendTextMessage(TextMessage message, {dynamic onSuccess(TextMessage)?, dynamic onError(CometChatException)?}) → Future<TextMessage?>
sendTextMessage used to send a text message
updateUser(User user, {dynamic onSuccess(User retUser)?, dynamic onError(CometChatException excep)?}) → Future<User?>
Updating a user similar to creating a user should ideally be achieved at your backend using the Restful APIs