Skip to main content

Conversations

New Properties

NameTypeDescription
hideNavigationBarBoolHides or shows the navigation bar in the conversations screen.
hideSearchBoolHides the search bar in the conversations screen.
hideLoadingStateBoolHides the loading state indicator.
hideDeleteConversationOptionBoolHides the option to delete a conversation.
hideGroupTypeBoolHides the group type indicator (private/public).
backgroundDrawableUIImageUsed to set a background image for the conversation screen.
separatorColorUIColorUsed to set the color of separators in the conversation list.
separatorWidthCGFloatUsed to set the width of separators in the conversation list.
errorTextColorUIColorUsed to set the color of error messages in the conversation UI.
lastMessageTextColorUIColorUsed to set the color of the last message text in the conversation list.
typingIndicatorColorUIColorUsed to set the color of the typing indicator in the conversation UI.
lastMessageAppearanceUIFontUsed to customize the appearance of the last message text in the list.
threadIndicatorAppearanceUIFontUsed to customize the appearance of thread indicators in the list.
dateTimeFormatter.timeClosureCalled to format a timestamp as a standard time (e.g., “12:30 PM”).
dateTimeFormatter.todayClosureCalled when rendering messages sent today.
dateTimeFormatter.yesterdayClosureCalled for yesterday’s messages.
dateTimeFormatter.lastweekClosureCalled for messages within the last week.
dateTimeFormatter.otherDayClosureCalled for dates older than last week.
dateTimeFormatter.minuteClosureCalled when referring to “a minute ago”.
dateTimeFormatter.minutesClosureCalled for “x minutes ago”.
dateTimeFormatter.hourClosureCalled for “an hour ago”.
dateTimeFormatter.hoursClosureCalled for “x hours ago”.
set(OnItemLongClick:)MethodTriggered when you long press on a ListItem of the Conversations component.
set(onEmpty:)MethodTriggered when the conversations list is empty.

Renamed Properties

v4 Namev5 NameTypeDescription
hide(error: Bool)hideErrorViewBoolHides the error state view.
show(backButton: Bool)hideBackButtonBoolControls visibility of the back button (logic inverted).
hide(receipt: Bool)hideReceiptsBoolHides message read/delivery receipts.
disable(userPresence: Bool)hideUserStatusBoolHides the online/offline status of users.
setOnItemClickset(OnItemClick:)MethodTriggered when clicking on a ListItem.
setOnBackset(onBack:)MethodOverride action when back button is pressed.
setOnSelectionset(onSelection:)MethodTriggered upon completion of selection.
setOnErrorset(onError:)MethodOverride action when an error occurs.

Removed Properties

NameTypeDescription
hide(separator: Bool)BoolUsed to control visibility of separators in the list view (replaced by style properties).
disable(typing: Bool)BoolUsed to toggle visibility of typing indicator.
setDatePatternMethodMethod to set custom date pattern (replaced by dateTimeFormatter object).
protectedGroupIconUIImageIcon shown for password protected groups.
sentIconUIImageReceipt icon shown when message status is sent.
deliveredIconUIImageReceipt icon shown when message status is delivered.
readIconUIImageReceipt icon shown when message status is read.

Users

New Properties

NameTypeDescription
set(options:)(User) -> [CometChatUserOption]Used to define custom options for each user.
add(options:)[CometChatUserOption]Used to dynamically add options to users.
set(leadingView:)(User) -> UIViewCustom leading view to be rendered for each user in the fetched list.
set(titleView:)(User) -> UIViewCustom title view to be rendered for each user in the fetched list.
set(trailView:)(User) -> UIViewCustom trailing view to be rendered for each user in the fetched list.
set(onEmpty:)() -> VoidTriggered when the users list is empty.
hideErrorViewBoolHides the error state view.
hideNavigationBarBoolHides or shows the navigation bar.
hideBackButtonBoolHides the back button.
hideLoadingStateBoolHides the loading state indicator.
hideUserStatusBoolHides the online/offline status of users.
hideSectionHeaderBoolHides the section header for table view indicating initials of users.
hideSearchBoolHides the search bar.
set(searchKeyword:)StringSets a search keyword for filtering users.
set(userRequestBuilder:)UsersRequest.UsersRequestBuilderSets a custom request builder for fetching users.
set(searchRequestBuilder:)UsersRequest.UsersRequestBuilderSets a custom request builder for searching users.
listItemSelectedImageUIImageImage shown when a list item is selected.
listItemDeSelectedImageUIImageImage shown when a list item is deselected.
searchIconTintColorUIColorTint color for the search icon in the search bar.
searchBarStyleUISearchBar.StyleStyle of the search bar (e.g., default, prominent).
searchTintColorUIColor?Tint color for the search bar elements.
searchBarTintColorUIColor?Background color for the search bar (excluding text input).
searchBarPlaceholderTextColorUIColor?Color of the placeholder text in the search bar.
searchBarPlaceholderTextFontUIFont?Font of the placeholder text in the search bar.
searchBarTextColorUIColor?Color of the entered text in the search bar.
searchBarTextFontUIFont?Font of the entered text in the search bar.
searchBarBackgroundColorUIColor?Background color of the search bar’s text input area.
searchBarCancelIconTintColorUIColor?Tint color for the cancel button in the search bar.
searchBarCrossIconTintColorUIColor?Tint color for the clear (cross) button in the search bar.
backgroundColorUIColorBackground color for the entire screen or view.
borderWidthCGFloatBorder width for the search bar or container.
borderColorUIColorColor of the border.
cornerRadiusCometChatCornerStyleCorner radius for search bar or other elements.
titleColorUIColorText color for title elements within the list or navigation bar.
titleFontUIFontFont for title text.
largeTitleColorUIColorText color for large titles.
largeTitleFontUIFont?Font for large titles.
navigationBarTintColorUIColorTint color for the navigation bar background.
navigationBarItemsTintColorUIColorTint color for navigation bar items (buttons, icons).
errorTitleTextFontUIFontFont for the error title displayed in UI.
errorTitleTextColorUIColorText color for the error title.
errorSubTitleFontUIFontFont for the subtitle of error messages.
errorSubTitleTextColorUIColorText color for the subtitle of error messages.
retryButtonTextColorUIColorText color for the retry button in error states.
retryButtonTextFontUIFontFont for the retry button text.
retryButtonBackgroundColorUIColorBackground color for the retry button.
retryButtonBorderColorUIColorBorder color for the retry button.
retryButtonBorderWidthCGFloatBorder width for the retry button.
retryButtonCornerRadiusCometChatCornerStyle?Corner radius for the retry button.
emptyTitleTextFontUIFontFont for the empty state title (when no users/items are present).
emptyTitleTextColorUIColorText color for the empty state title.
emptySubTitleFontUIFontFont for the subtitle in the empty state.
emptySubTitleTextColorUIColorText color for the subtitle in the empty state.
tableViewSeparatorUIColorColor for the table view separator.
listItemTitleTextColorUIColorText color for list item titles.
listItemTitleFontUIFontFont for list item titles.
listItemSubTitleTextColorUIColorText color for list item subtitles.
listItemSubTitleFontUIFontFont for list item subtitles.
listItemBackgroundUIColorBackground color for individual list items.
listItemBorderWidthCGFloatBorder width for individual list items.
listItemBorderColorUIColorBorder color for individual list items.
listItemCornerRadiusCometChatCornerStyleCorner radius for list items.
listItemSelectionImageTintUIColorTint color for selection indicator in list items.
listItemSelectedBackgroundUIColorBackground color for selected list items.
listItemDeSelectedImageTintUIColorTint color for the deselected state image.
headerTitleColorUIColorText color for section header titles in the list.
headerTitleFontUIFontFont for section header titles.

Renamed Properties

NameTypeDescriptionOld Name
set(listItemView:)(User) -> UIViewCustom list item view to be rendered for each user in the list.setListItemView
set(subtitleView:)(User) -> UIViewCustom subtitle view to be rendered for each user in the fetched list.setSubtitleView
set(emptyView:)UIViewCustom empty state view to be displayed when the user list is empty.setEmptyStateView
set(errorView:)UIViewCustom error state view to be displayed when an error occurs while fetching users.setErrorStateView
set(onItemClick:)(User) -> VoidTriggered when you click on a ListItem of the users component.setOnItemClick
set(onItemLongClick:)(User) -> VoidTriggered when you long press on a ListItem of the users component.setOnItemLongClick
set(onBack:)() -> VoidTriggered when the back button is pressed in the users component.setOnBack
set(onSelection:)([User]) -> VoidTriggered on every selection when selection mode is set to multiple or single.setOnSelection
set(onError:)(CometChatException) -> VoidTriggered when an error occurs in the users component.setOnError

Removed Properties

NameTypeDescription
set(loadingStateView:)UIActivityIndicatorView.StyleUsed to set size of loading view icon while fetching the list of users.
hide(errorText:)BoolUsed to hide error text on fetching users.
show(backButton:)BoolUsed to toggle visibility for back button.
set(searchIcon:)UIImage?Used to set search Icon in the search field.
hide(search:)BoolUsed to toggle visibility for search box.
hide(separator:)BoolUsed to hide the divider separating the user items.
disable(userPresence:)BoolUsed to control visibility of user indicator shown if user is online.
set(emptyStateText:)StringUsed to set a custom text response when fetching the users has returned an empty list.
set(errorStateText:)StringUsed to set a custom text response when some error occurs on fetching the list of users.
set(searchPlaceholder:)StringUsed to set search placeholder text.
set(title:mode:)String, UINavigationItem.LargeTitleDisplayModeUsed to set title in the app with display mode.
setOnLoad([User]) -> VoidGets triggered when a user list is fully fetched and displayed on the screen.

Groups

New Properties

NameTypeDescription
set(onSelection:)ClosureGets triggered when selection mode is set to multiple or single. Triggers on every selection and returns the list of selected groups.
set(onEmpty:)ClosureGets triggered when the groups list is empty in CometChatGroups.
setOnLoadClosureGets triggered when a group list is fully fetched and going to be displayed on the screen. Returns the list of groups to be displayed.
listItemSelectedImageUIImageCheck box image when a list item is selected.
listItemDeSelectedImageUIImageCheck box image when a list item is deselected.
searchIconTintColorUIColorTint color for the search icon, defaults to the secondary icon color from CometChatTheme.
searchBarStyleUISearchBarStyleStyle of the search bar, defaulting to the standard style.
searchTintColorUIColorTint color for the search bar, defaults to the primary color from CometChatTheme.
searchBarTintColorUIColorBackground color of the search bar, defaulting to clear.
searchBarPlaceholderTextColorUIColorPlaceholder text color for the search bar, defaults to the tertiary text color from CometChatTheme.
searchBarPlaceholderTextFontUIFontFont used for the placeholder text in the search bar, defaults to regular body font.
searchBarTextColorUIColorColor of the text entered in the search bar, defaults to the primary text color from CometChatTheme.
searchBarTextFontUIFontFont used for the text in the search bar, defaults to regular body font.
searchBarBackgroundColorUIColorBackground color of the search bar, defaults to a specific background color from CometChatTheme.
searchBarCancelIconTintColorUIColorTint color for the cancel icon in the search bar, defaults to the primary color from CometChatTheme.
searchBarCrossIconTintColorUIColorTint color for the cross icon in the search bar, defaults to the secondary icon color from CometChatTheme.
backgroundColorUIColorBackground color of the overall view, defaults to a specific background color from CometChatTheme.
borderWidthCGFloatWidth of the border around the view, defaults to 0 (no border).
borderColorUIColorColor of the border around the view, defaults to clear.
cornerRadiusCometChatCornerStyleCorner radius settings for the view, defaults to no corner radius.
titleColorUIColorColor for the title text, defaults to the primary text color from CometChatTheme.
titleFontUIFontFont used for the title text, defaults to nil (not set).
largeTitleColorUIColorColor for the large title text, defaults to the primary text color from CometChatTheme.
largeTitleFontUIFontFont used for the large title text, defaults to nil (not set).
navigationBarTintColorUIColorBackground color of the navigation bar, defaults to a specific background color from CometChatTheme.
navigationBarItemsTintColorUIColorTint color for items in the navigation bar, defaults to the highlight color from CometChatTheme.
errorTitleTextFontUIFontFont used for the error title text, defaults to a bold heading 3 font from CometChatTypography.
errorTitleTextColorUIColorColor of the error title text, defaults to the primary text color from CometChatTheme.
errorSubTitleFontUIFontFont used for the error subtitle text, defaults to regular body font.
errorSubTitleTextColorUIColorColor of the error subtitle text, defaults to the secondary text color from CometChatTheme.
retryButtonTextColorUIColorColor for the retry button text, defaults to button text color from CometChatTheme.
retryButtonTextFontUIFontFont used for the retry button text, defaults to medium button font from CometChatTypography.
retryButtonBackgroundColorUIColorBackground color for the retry button, defaults to the primary color from CometChatTheme.
retryButtonBorderColorUIColorBorder color for the retry button, defaults to clear.
retryButtonBorderWidthCGFloatWidth of the border around the retry button, defaults to 0 (no border).
retryButtonCornerRadiusCometChatCornerStyleCorner radius settings for the retry button, defaults to a specific corner radius from CometChatSpacing.
emptyTitleTextFontUIFontFont used for the empty state title text, defaults to a bold heading 3 font from CometChatTypography.
emptyTitleTextColorUIColorColor of the empty state title text, defaults to the primary text color from CometChatTheme.
emptySubTitleFontUIFontFont used for the empty state subtitle text, defaults to regular body font.
emptySubTitleTextColorUIColorColor of the empty state subtitle text, defaults to the secondary text color from CometChatTheme.
tableViewSeparatorUIColorColor of the table view separator, defaults to clear.
listItemTitleTextColorUIColorColor of the title text in list items, defaults to the primary text color from CometChatTheme.
listItemTitleFontUIFontFont used for the title text in list items, defaults to medium heading 4 font from CometChatTypography.
listItemSubTitleTextColorUIColorColor of the subtitle text in list items, defaults to the secondary text color from CometChatTheme.
listItemSubTitleFontUIFontFont used for the subtitle text in list items, defaults to regular body font.
listItemBackgroundUIColorBackground color for list items, defaults to clear.
listItemSelectedBackgroundUIColorBackground color for list items if selected, defaults to clear.
listItemBorderWidthCGFloatWidth of the border around list items, defaults to 0 (no border).
listItemBorderColorUIColorColor of the border around list items, defaults to the light border color from CometChatTheme.
listItemCornerRadiusCometChatCornerStyleCorner radius settings for list items, defaults to no corner radius.
listItemSelectionImageTintUIColorTint color for the selection image in list items, defaults to the highlight color from CometChatTheme.
listItemDeSelectedImageTintUIColorTint color for the deselected image in list items.
passwordGroupImageTintColorUIColorTint color for the password group image, defaults to the background color from CometChatTheme.
passwordGroupImageBackgroundColorUIColorBackground color for the password group image, defaults to the warning color from CometChatTheme.
privateGroupImageTintColorUIColorTint color for the private group image, defaults to the background color from CometChatTheme.
privateGroupImageBackgroundColorUIColorBackground color for the private group image, defaults to the success color from CometChatTheme.
privateGroupIconUIImageImage for a private group icon.
protectedGroupIconUIImageImage for a protected group icon.
set(groupsRequestBuilder:)GroupsRequest.GroupsRequestBuilderSets the request builder for fetching groups.
set(searchRequestBuilder:)GroupsRequest.GroupsRequestBuilderSets the request builder for searching groups.
set(searchKeyword:)StringSets the search keyword to filter groups.
hideErrorViewBoolHides the error state view.
hideNavigationBarBoolHides or shows the navigation bar.
hideSearchBoolHides the search bar.
hideBackButtonBoolHides the back button.
hideLoadingStateBoolHides the loading state indicator.
hideReceiptsBoolHides message read/delivery receipts.
hideDeleteConversationOptionBoolHides the option to delete a conversation.
hideUserStatusBoolHides the online/offline status of users.
hideGroupTypeBoolHides the group type (private/public).
set(options:)(Group?) -> [CometChatGroupOption]Allows you to define custom options for each group. Returns an array of CometChatGroupOption based on the group object.
add(options:)(Group?) -> [CometChatGroupOption]Dynamically adds options to groups. Returns additional CometChatGroupOption elements.
set(leadingView:)(Group?) -> UIViewAllows you to modify the leading view of a group cell.
set(titleView:)(Group?) -> UIViewAllows you to customize the title view of a group cell.
set(trailView:)(Group?) -> UIViewAllows you to modify the trailing view of a group cell.

Renamed Properties

NameTypeDescriptionOld Name
set(onItemClick:)ClosureTriggered when you click on a ListItem of the groups component.SetOnItemClick
set(OnItemLongClick:)ClosureTriggered when you long press on a ListItem of the groups component.SetOnItemLongClick
set(onError:)ClosureTriggered when an error occurs in CometChatGroups.SetOnError
set(onBack:)ClosureTriggered when the back button is pressed in CometChatGroups.SetOnBack
SetListItemView(Group?) -> UIViewAssigns a custom ListItem to the Groups Component.setListItemView
SetSubTitleView(Group?) -> UIViewAllows you to customize the subtitle view for each group item.setSubtitleView

Removed Properties

No properties were removed in v5. All v4 properties have been retained (with some renamed) and additional functionality has been added.

Group Members

New Properties

NameTypeDescription
retryButtonTextColorUIColorSets the text color for the retry button.
retryButtonTextFontUIFontSets the text font for the retry button.
retryButtonBackgroundColorUIColorSets the background color for the retry button.
retryButtonBorderColorUIColorSets the border color for the retry button.
retryButtonBorderWidthCGFloatSets the border width for the retry button.
retryButtonCornerRadiusCometChatCornerStyleSets the corner radius for the retry button.
listItemSelectedBackgroundUIColorSets the background color for selected list items.
listItemDeSelectedImageTintUIColorSets the tint color for deselected list item images.
listItemSelectionImageTintUIColorSets the tint color for selected list item images.
listItemSelectedImageUIImageSets the image for selected list items.
listItemDeSelectedImageUIImageSets the image for deselected list items.
largeTitleColorUIColor?Sets the color for the large title text.
navigationBarTintColorUIColor?Sets the tint color for the navigation bar.
navigationBarItemsTintColorUIColor?Sets the tint color for navigation bar items.
errorTitleTextFontUIFontSets the font for the error title text.
errorTitleTextColorUIColorSets the color for the error title text.
errorSubTitleFontUIFontSets the font for the error subtitle text.
errorSubTitleTextColorUIColorSets the color for the error subtitle text.
emptyTitleTextFontUIFontSets the font for the empty state title text.
emptyTitleTextColorUIColorSets the color for the empty state title text.
emptySubTitleFontUIFontSets the font for the empty state subtitle text.
emptySubTitleTextColorUIColorSets the color for the empty state subtitle text.
tableViewSeparatorUIColorSets the color for the table view separator.
listItemTitleTextColorUIColorSets the text color for list item titles.
listItemTitleFontUIFontSets the font for list item titles.
listItemSubTitleTextColorUIColorSets the text color for list item subtitles.
listItemSubTitleFontUIFontSets the font for list item subtitles.
listItemBackgroundUIColorSets the background color for list items.
listItemBorderWidthCGFloatSets the border width for list items.
listItemBorderColorUIColorSets the border color for list items.
listItemCornerRadiusCometChatCornerStyleSets the corner radius for list items.
messageTypeImageTintUIColorSets the tint color for message type icons.
passwordGroupImageTintColorUIColorSets the tint color for password group icons.
passwordGroupImageBackgroundColorUIColorSets the background color for password group icons.
privateGroupImageTintColorUIColorSets the tint color for private group icons.
privateGroupImageBackgroundColorUIColorSets the background color for private group icons.
backgroundColorUIColorSets the background color for the component.
set(groupMembersRequestBuilder:)GroupMembersRequest.GroupMembersRequestBuilderSets the request builder for fetching group members.
set(searchRequestBuilder:)GroupMembersRequest.GroupMembersRequestBuilderSets the request builder for searching group members.
set(searchKeyword:)StringSets the search keyword to filter group members.
hideErrorBoolHides the error state view.
hideUserStatusBoolHides the online/offline status of users.
hideNavigationBarBoolHides or shows the navigation bar.
hideLoadingStateBoolHides the loading state indicator.
hideBackIconBoolHides the back button/icon.
hideKickMemberOptionBoolHides the option to kick a member from the group.
hideBanMemberOptionBoolHides the option to ban a member from the group.
hideScopeChangeOptionBoolHides the option to change a member’s scope (role).
hideSearchBoolHides the search bar.
set(onSelection:)([GroupMember]) -> VoidTriggers on every selection and returns the list of selected group members.
set(onEmpty:)() -> VoidTriggers when the groups list is empty.
set(onLoad:)([GroupMember]) -> VoidTriggers when group members list is fully fetched and displayed.
set(onItemClick:)(GroupMember, IndexPath) -> VoidTriggered when you click on a ListItem.
set(onItemLongClick:)(GroupMember, IndexPath) -> VoidTriggered when you long press on a ListItem.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(onBack:)() -> VoidTriggered when back button is pressed.
set(leadingView:)(GroupMember?) -> UIViewSets a custom leading view for group member cells.
set(titleView:)(GroupMember?) -> UIViewSets a custom title view for group member cells.
set(loadingView:)UIViewSets a custom loading view displayed while data is being fetched.
set(errorView:)UIViewSets a custom error view that appears when an error occurs.
set(emptyView:)UIViewSets a custom empty state view when no group members are available.
setListItemView(GroupMember?) -> UIViewAssigns a custom ListItem to the GroupMembers component.
setSubtitleView(GroupMember?) -> UIViewSets a custom subtitle view for each GroupMembers item.
setTailView(GroupMember?) -> UIViewSets a custom tail view for group member cells.
setOptions[CometChatGroupMemberOption]Sets custom options for swipe actions.
set(menus:)UIViewSets custom menus to add more options.

Renamed Properties

NameTypeDescriptionOld Name
backgroundColorUIColorSets the background color for the component.background
hideUserStatusBoolHides/disables the online/offline status of users.disable(userPresence:)
hideSearchBoolHides the search bar.hide(search:)
hideUserStatusBoolHide user presence. If set to true, the status indicator is not displayed.disableUsersPresence
set(onItemClick:)(GroupMember, IndexPath) -> VoidTriggered when you click on a ListItem.setOnItemClick
set(onItemLongClick:)(GroupMember, IndexPath) -> VoidTriggered when you long press on a ListItem.setOnItemLongClick
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.setOnError
set(onBack:)() -> VoidTriggered when back button is pressed.setOnBack

Removed Properties

NameTypeDescription
backIconTintUIColorSets the back button tint color.
searchIconTintUIColorSets the search icon tint color.
searchTextFontUIFontSets the search text font.
searchTextColorUIColorSets the search text color.
searchCancelButtonTintUIColorSets the search cancel icon tint.
searchPlaceholderFontUIFontSets the search placeholder font.
searchPlaceholderColorUIColorSets the search placeholder color.
addButtonTintUIColorSets add button color.
addButtonFontUIFontSets add button font.
avatarStyleAvatarStyleStyles to apply to the avatar component of the default list item view.
statusIndicatorStyleCSSPropertiesStyles to apply to the status indicator component of the default list item view.
listItemStyleListItemStyleStyles to apply to the default list item view.
groupScopeStyleChangeScopeStyleStyles to apply to the change scope component.
groupMembersStyleGroupMembersStyleStyles to apply to this component.
set(title:mode:)String, UINavigationItem.LargeTitleDisplayModeCustom title for the component.
set(backButtonTitle:)String?Custom text for the back button.
set(searchPlaceholder:)StringCustom placeholder text for search field.
show(backButton:)BoolWhether to show the back button.
set(errorStateText:)StringCustom error state text.
set(backButtonIcon:)UIImageCustom back button icon.
set(passwordPlaceholderText:)StringCustom placeholder text for password.
hide(continueButton:)BoolWhether to hide the continue button.
set(searchIcon:)UIImageSets the icon for the search bar.
set(searchClearIcon:)UIImageSets the clear icon for the search bar.
set(searchBarHeight:)CGFloatSet the height for the search bar.
selectionMode(mode:)SelectionModeEnables selection mode (.single, .multiple).
hide(separator:)BoolHide/unhide the separator.
clearList()-Clears the users locally.
update(groupMember:)GroupMemberUpdates member object locally.
remove(groupMember:)GroupMemberRemoves member object locally.
size()-Returns the count of members displayed.
titleStringTitle of the component.
searchPlaceholderStringText to be displayed when the search input has no value.
fetchTimeOutanyTimeout reference for fetching users.
userPresencePlacementUserPresencePlacementPlacement of user presence information within the user interface.
backButtonIconURLStringImage URL for the back button.
showBackButtonBoolShow back button.
closeButtonIconURLStringImage URL for the close button.
dropDownIconURLStringImage URL for the change scope component’s arrowIconURL prop.
emptyStateTextStringText to display in the default empty view.
errorStateTextStringText to display in the default error view.
loadingIconURLStringImage URL for the default loading view.
hideSeparatorBoolHide the separator at the bottom of the default list item view.
titleAlignmentTitleAlignmentAlignment of the title text.
searchIconURLStringImage URL for the search icon to use in the search bar.
fetchingUsersBoolFlag to indicate whether users are currently being fetched.
onClose() -> VoidFunction to call when the close button is clicked.
headerViewUIViewCustom header view which will replace the title as well.

Message Header

New Properties

NameTypeDescription
titleTextColorUIColorUsed to set the text color of the header title.
titleTextFontUIFontUsed to set the font style of the header title.
subtitleTextColorUIColorUsed to set the text color of the subtitle in the header.
subtitleTextFontUIFontUsed to set the font style of the subtitle in the header.
backButtonImageTintColorUIColorUsed to set the tint color of the back button image in the header.
privateGroupBadgeImageTintColorUIColorUsed to set the tint color of the private group badge in the header.
passwordProtectedGroupBadgeImageTintColorUIColorUsed to set the tint color of the password-protected group badge in the header.
privateGroupImageBackgroundColorUIColorUsed to set the background color of the private group badge.
passwordGroupImageBackgroundColorUIColorUsed to set the background color of the password-protected group badge.
groupImageBackgroundColorUIColorUsed to set the background color for group icons in the header.
avatarStyleAvatarStyleUsed to customize the appearance of the avatar in the header.
backgroundColorUIColorUsed to set the background color of the header.
cornerRadiusCometChatCornerStyleUsed to set the corner radius of the header.
borderWidthCGFloatUsed to set the border width of the header.
borderColorUIColorUsed to set the border color of the header.
backButtonIconUIImageUsed to set a custom icon for the back button.
privateGroupIconUIImageUsed to set a custom icon for private groups.
protectedGroupIconUIImageUsed to set a custom icon for password-protected groups.
backgroundImageUIImageUsed to set a background image for the header.
hideBackButtonBoolHides the back button of message header.
hideUserStatusBoolHides or shows the user status of user (online/offline/last active at).
hideVideoCallButtonBoolHides the video call button.
hideVoiceCallButtonBoolHides the voice call button.
set(onBack:)() -> VoidTriggered when back button is pressed.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(listItemView:)(User?, Group?) -> UIViewAssigns a custom ListItem to the message header component.
set(leadingView:)(User?, Group?) -> UIViewSets a custom leading view for message header.
set(titleView:)(User?, Group?) -> UIViewSets a custom title view for message header.
set(trailView:)(User?, Group?) -> UIViewSets a custom trailing view for message header.
set(subtitleView:)(User?, Group?) -> UIViewSets a custom subtitle view for message header.
dateTimeFormatterCometChatDateTimeFormatterSupports full customization of how date and time are displayed.

Renamed Properties

NameTypeDescriptionOld Name
backgroundColorUIColorSets the background color for the component.background
backButtonImageTintColorUIColorSets the tint color of the back button image in the header.backIconTint
hideBackButtonBoolHides the back button of message header.hide(backButton:)
hideUserStatusBoolHides or shows the user status of user.set(disableUsersPresence:)
set(menus:)(User?, Group?) -> UIViewSets custom menus to add more options.setMenus
set(subtitleView:)(User?, Group?) -> UIViewSets a custom subtitle view for message header.setSubtitleView

Removed Properties

NameTypeDescription
typingIndicatorTextFontUIFontSets the typing indicator text font.
typingIndicatorTextColorUIColorSets the typing indicator text color.
detailIconTintUIColorSets the tint color for detail icon for message header.
onlineStatusColorUIColorSets the online status color for message header.
privateGroupIconBackgroundColorUIColorSets the private group background color for message header (replaced by privateGroupImageBackgroundColor).
protectedGroupIconBackgroundColorUIColorSets the protected group background color for message header (replaced by passwordGroupImageBackgroundColor).
set(protectedGroupIcon:)UIImageUsed to set custom protected group icon.
set(privateGroupIcon:)UIImageUsed to set custom private group icon.
disable(typing:)BoolUsed to enable/disable typing indicators.

Message List

New Properties

NameTypeDescription
hideAvatarBoolHides the avatar of the sender.
hideGroupActionMessagesBoolHides group action messages (like join/leave notifications).
hideReplyInThreadOptionBoolHides the reply in thread option.
hideTranslateMessageOptionBoolHides the message translation option.
hideEditMessageOptionBoolHides the edit message option.
hideDeleteMessageOptionBoolHides the delete message option.
hideReactionOptionBoolHides the reaction option on messages.
hideMessagePrivatelyOptionBoolHides the option to message privately.
hideCopyMessageOptionBoolHides the option to copy a message.
hideMessageInfoOptionBoolHides the message info option.
hideHeaderViewBoolHides the header view of the message list.
hideFooterViewBoolHides the footer view of the message list.
hideDateSeparatorBoolHides the date separator between messages.
scrollToBottomOnNewMessagesBoolScrolls to the bottom when new messages arrive.
hideReceiptsBoolHides the message read receipts (ticks).
disableSoundForMessagesBoolDisables the sound when a new message arrives.
hideEmptyViewBoolHides the empty state view when no messages are available.
hideErrorViewBoolHides the error view when an error occurs.
hideLoadingViewBoolHides the loading view when fetching messages.
hideNewMessageIndicatorBoolHides the “new message” indicator.
backgroundColorUIColorBackground color with dynamic support for light and dark mode.
borderWidthCGFloatBorder width for the component.
borderColorUIColorBorder color for the component.
cornerRadiusCometChatCornerStyleCorner radius for the component.
shimmerGradientColor1UIColorFirst color of the shimmer gradient.
shimmerGradientColor2UIColorSecond color of the shimmer gradient.
emptyStateTitleColorUIColorText color for the title in the empty state.
emptyStateTitleFontUIFontFont for the title in the empty state.
emptyStateSubtitleColorUIColorText color for the subtitle in the empty state.
emptyStateSubtitleFontUIFontFont for the subtitle in the empty state.
errorStateTitleColorUIColorText color for the title in the error state.
errorStateTitleFontUIFontFont for the title in the error state.
errorStateSubtitleColorUIColorText color for the subtitle in the error state.
errorStateSubtitleFontUIFontFont for the subtitle in the error state.
threadedMessageImageUIImageIcon image for threaded messages.
errorImageUIImageIcon image for error state.
emptyImageUIImageIcon image for empty state.
newMessageIndicatorImageUIImageIcon image for new message indicator.
backgroundImageUIImageBackground image for the component.
scrollToBottom(isAnimated:)BoolScrolls to the bottom of the message list.
set(messageAlignment:)MessageListAlignmentSets the alignment of messages in the list.
set(smartRepliesKeywords:)[String]Sets keywords for smart replies.
set(smartRepliesDelayDuration:)IntSets the delay duration for smart replies.
set(user:parentMessage:)User, BaseMessage?Sets the user and an optional parent message.
set(group:parentMessage:)Group, BaseMessage?Sets the group and an optional parent message.
set(messagesRequestBuilder:)MessagesRequest.MessageRequestBuilderSets the message request builder.
set(reactionsRequestBuilder:)ReactionsRequest.ReactionsRequestBuilderSets the reactions request builder.
set(parentMessageId:)IntSets the parent message ID.
set(onThreadRepliesClick:)(BaseMessage, CometChatMessageTemplate) -> VoidTriggered when you click on the thread indicator of message bubble.
set(onReactionClick:)(CometChat.ReactionCount, BaseMessage) -> VoidTriggered when you click on a reaction on a message bubble.
set(onReactionListItemClick:)(CometChat.Reaction, BaseMessage) -> VoidTriggered when you click on the list item of CometChatReactionList.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(onEmpty:)() -> VoidTriggers when the message list is empty.
set(onLoad:)([BaseMessage]) -> VoidTriggers when message list is fully fetched and displayed.
set(headerView:)UIViewSets a custom header view for message list.
set(footerView:)UIViewSets a custom footer view for message list.
set(dateSeparatorPattern:)(Int?) -> StringSets the date separator pattern using a closure.
set(datePattern:)(Int?) -> StringSets the date pattern using a closure.
set(timePattern:)(Int?) -> StringSets the time pattern using a closure.
set(textFormatter:)[CometChatTextFormatter]Sets the list of text formatters.
set(loadingView:)UIViewSets a custom loading view displayed while data is being fetched.
set(errorView:)UIViewSets a custom error view that appears when an error occurs.
set(emptyView:)UIViewSets a custom empty state view when no messages are available.
set(templates:)[CometChatMessageTemplate]Sets message templates to MessageList.
dateTimeFormatterCometChatDateTimeFormatterSupports full customization of how date and time are displayed.
set(controller:)UIViewControllerSets the controller (mandatory for proper configuration).

Renamed Properties

NameTypeDescriptionOld Name
hideReceiptsBoolHides the message read receipts.hide(receipt:)
hideAvatarBoolShows/hides the avatar of the sender.show(avatar:)
backgroundColorUIColorSets the background color for the component.background
set(messageAlignment:)MessageListAlignmentSets the alignment of messages in the list.alignment

Removed Properties

NameTypeDescription
loadingIconTintUIColorUsed to set loading icon tint.
emptyTextFontUIFontUsed to set empty state text font.
errorTextFontUIFontUsed to set error text font.
emptyTextColorUIColorUsed to set empty state text color.
errorTextColorUIColorUsed to set error state text color.
nameTextColorUIColorUsed to set sender/receiver name text color on a message bubble.
nameTextFontUIFontUsed to set sender/receiver name text appearance on a message bubble.
timestampTextColorUIColorUsed to set time stamp text color.
threadReplySeperatorColorUIColorUsed to set thread reply separator color.
threadReplyTextColorUIColorUsed to set thread reply text color.
threadReplyTextFontUIFontUsed to set thread reply text appearance.
hide(error:)BoolUsed to hide the error view.
messageInformationConfigurationMessageInformationConfigurationConfiguration for message information component.
reactionsConfigurationReactionsConfigurationConfiguration for reactions component.
setDateSeparatorPattern(Int?) -> StringUsed to modify the date pattern of the message list date separator.
setDatePattern(Int?) -> StringUsed to modify the date pattern.
setHeaderViewUIViewUsed to set custom header view (now set(headerView:)).
setFooterViewUIViewUsed to set custom footer view (now set(footerView:)).
setTextFormatters[CometChatTextFormatter]Used to set text formatters (now set(textFormatter:)).
setMentionsFormatters[CometChatTextFormatter]Used to set mentions formatters (merged into set(textFormatter:)).
setErrorStateViewUIViewUsed to set custom error view (now set(errorView:)).
setEmptyStateViewUIViewUsed to set custom empty state view (now set(emptyView:)).
setOnThreadRepliesClickClosureCallback for thread replies click (now set(onThreadRepliesClick:)).

Message Composer

New Properties

NameTypeDescription
placeHolderTextFontUIFontFont for the placeholder text in the input field.
placeHolderTextColorUIColorColor for the placeholder text in the input field.
textFiledColorUIColorText color for the input field.
textFiledFontUIFontFont for the input field text.
backgroundColorUIColorBackground color with dynamic support for light and dark mode.
cornerRadiusCometChatCornerStyleCorner radius for the composer.
borderWidthCGFloatBorder width for the composer.
borderColorUIColorBorder color for the composer.
sendButtonImageUIImageIcon for the send button.
sendButtonImageTintUIColorTint color for the send button image.
activeSendButtonImageBackgroundColorUIColorBackground color for the send button when active.
inactiveSendButtonImageBackgroundColorUIColorBackground color for the send button when inactive.
composeBoxBackgroundColorUIColorBackground color for the compose box.
composeBoxBorderColorUIColorBorder color for the compose box.
composeBoxBorderWidthCGFloatBorder width for the compose box.
composerBoxCornerRadiusCometChatCornerStyleCorner radius for the compose box.
composerSeparatorColorUIColorColor for the separator in the compose box.
attachmentImageUIImageIcon for the attachment button.
attachmentImageTintUIColorTint color for the attachment image.
voiceRecordingImageUIImageIcon for the voice recording button.
voiceRecordingImageTintUIColorTint color for the voice recording image.
aiImageUIImageIcon for the AI button.
aiImageTintUIColorTint color for the AI image.
stickerImageUIImageIcon for the sticker button.
stickerTintUIColorTint color for the sticker image.
editPreviewTitleTextFontUIFontFont for the title in the edit preview.
editPreviewMessageTextFontUIFontFont for the message text in the edit preview.
editPreviewTitleTextColorUIColorText color for the title in the edit preview.
editPreviewMessageTextColorUIColorText color for the message in the edit preview.
editPreviewBackgroundColorUIColorBackground color for the edit preview.
editPreviewCornerRadiusCometChatCornerStyleCorner radius for the edit preview.
editPreviewBorderColorUIColorBorder color for the edit preview.
editPreviewBorderWidthCGFloatBorder width for the edit preview.
editPreviewCloseIconUIImageIcon for closing the edit preview.
editPreviewCloseIconTintUIColorTint color for the close icon in the edit preview.
infoIconUIImageIcon for the info button.
infoIconTintUIColorTint color for the info icon.
infoTextColorUIColorText color for the info text.
infoTextFontUIFontFont for the info text.
infoSeparatorColorUIColorColor for the separator in the info section.
infoBackgroundColorUIColorBackground color for the info section.
infoCornerRadiusCometChatCornerStyleCorner radius for the info section.
infoBorderColorUIColorBorder color for the info section.
infoBorderWidthCGFloatBorder width for the info section.
setInitialComposerTextStringSets the initial text in the composer when it loads.
disableTypingEventsBoolDisables sending typing indicators when the user types.
disableMentionsBoolDisables the mention feature in the composer.
hideImageAttachmentOptionBoolHides the option to attach images.
hideVideoAttachmentOptionBoolHides the option to attach videos.
hideAudioAttachmentOptionBoolHides the option to attach audio files.
hideFileAttachmentOptionBoolHides the option to attach files.
hidePollsOptionBoolHides the option to create polls.
hideCollaborativeDocumentOptionBoolHides the option for collaborative documents.
hideCollaborativeWhiteboardOptionBoolHides the option for collaborative whiteboards.
hideAttachmentButtonBoolHides the attachment button in the composer.
hideVoiceRecordingButtonBoolHides the voice recording button.
hideStickersButtonBoolHides the stickers button.
hideSendButtonBoolHides the send button.
set(user:)UserSets the user for direct messaging.
set(group:)GroupSets the group for group messaging.
set(parentMessageId:)IntSets the parent message ID for replying in a thread.
set(maxLine:)IntSets the maximum number of lines for the composer input.
set(customSoundForMessages:)URL?Sets a custom sound for sending messages.
disableSoundForMessagesBoolDisables sound while sending messages.
set(onSendButtonClick:)(BaseMessage) -> VoidOverride the action triggered upon pressing the send button.
set(onTextChanged:)(String) -> VoidGets activated when the user starts typing in message composer.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(attachmentOptions:)(User?, Group?, UIViewController?) -> [CometChatMessageComposerAction]Sets a list of custom MessageComposerActions.
set(sendButtonView:)(User?, Group?) -> UIViewSets a custom send button for the MessageComposer Component.
set(headerView:)(User?, Group?) -> UIViewSets a custom header view for the MessageComposer Component.
set(footerView:)(User?, Group?) -> UIViewSets a custom footer view for the MessageComposer Component.
set(textFormatter:)[CometChatTextFormatter]Assigns the list of text formatters.
set(controller:)UIViewControllerSets the controller (mandatory for proper configuration).
mediaRecorderStyleMediaRecorderStyleCustomizes the media recording styling.
aiOptionsStyleAIOptionsStyleCustomizes the AI options styling.

Renamed Properties

NameTypeDescriptionOld Name
backgroundColorUIColorSets the background color for the component.background
hideVoiceRecordingButtonBoolHides the voice recording button.hide(voiceRecording:)
disableTypingEventsBoolDisables sending typing indicators when the user types.disable(disableTypingEvents:)
disableSoundForMessagesBoolDisables sound while sending messages.disable(disableSoundForMessages:)
set(textFormatter:)[CometChatTextFormatter]Assigns the list of text formatters.setMentionsFormatters

Removed Properties

NameTypeDescription
inputBackgroundUIColorSets the input background color of message composer.
textFontUIFontSets the input text font of message composer.
inputBoxPlaceholderFontUIFontSets the placeholder text font for message composer input field.
placeHolderTextColorUIColorSets the placeholder text color for message composer input field (renamed with different casing).
attachmentIconTintUIColorSets the attachment icon tint color.
sendIconTintUIColorSets send button icon tint color.
separatorTintUIColorSets the separator color for message composer.
inputBorderWidthCGFloatSets the border width for message composer input view.
inputBorderColorUIColorSets the border color for message composer input view.
actionSheetTitleColorUIColorSets the title color for action sheet of message composer.
actionSheetTitleFontUIFontSets the title font for action sheet of message composer.
actionSheetLayoutModelIconTintUIColorSets action sheet layout mode icon tint color for message composer.
actionSheetCancelButtonIconTintUIColorSets action sheet cancel button icon tint color for message composer.
actionSheetCancelButtonIconFontUIFontSets the action sheet cancel button icon font color for message composer.
actionSheetSeparatorTintUIColorSets the separator color for action sheet items.
actionSheetBackgroundUIColorSets the background color of action sheet.
voiceRecordingIconTintUIColorSets the voice recorder icon tint color.
aiIconTintUIColorSets the ai icon tint color.
infoTextColorUIColorSets the text color for info message displayed (now part of style).
infoIconTintColorUIColorSets the tint color for info icon.
infoBackgroundColorUIColorSets the background color for info message view (now part of style).
infoSeparatorColorUIColorSets the separator color for info view (now part of style).
set(background:)UIColorSets background color for message composer.
set(placeholderText:)StringSets message composer’s placeholder text.
set(maxLines:)IntSets limit for lines of text to be displayed in input field.
set(auxiliaryButtonAlignment:)AuxiliaryButtonAlignmentSets position for auxiliary buttons view.
set(customSoundForMessage:)URLSets custom sounds for outgoing messages.
set(liveReactionIconURL:)UIImageSets custom live reaction icon.
set(disableMentions:)BoolEnables/Disables user mentions in message composer input field.
set(infoIcon:)UIImageSets image for info icon (now part of style).
set(attachmentIcon:)UIImageSets image for attachment button on message composer.
set(aiAuxiliaryIcon:)UIImageSets image for ai auxillary button.
setOnSendButtonClickClosureSets custom actions for send button click.
hide(liveReaction:)BoolToggles visibility for live reaction component.
hide(footerView:)BoolToggles visibility for footer view of message composer.
hide(headerView:)BoolToggles visibility for header view of message composer.
hide(sendButton:)BoolToggles visibility for send button.
setAttachmentOptionsClosureSets a list of custom MessageComposerActions.
setAuxilaryButtonViewClosureSets custom auxiliary button view.
setSecondaryButtonViewClosureSets custom secondary button view.
setSendButtonViewClosureSets custom send button view.

Call Logs

New Properties

NameTypeDescription
listItemTitleTextColorUIColorText color for the list item title.
listItemTitleFontUIFontFont for the list item title.
listItemSubTitleTextColorUIColorText color for the list item subtitle.
listItemSubTitleFontUIFontFont for the list item subtitle.
listItemBackgroundUIColorBackground color for the list item.
listItemSelectedBackgroundUIColorBackground color for the selected list item.
listItemBorderWidthCGFloatBorder width for the list item.
listItemBorderColorUIColorBorder color for the list item.
listItemCornerRadiusCometChatCornerStyleCorner radius for the list item.
listItemSelectionImageTintUIColorTint color for the selection image.
listItemDeSelectedImageTintUIColorTint color for the deselected image.
listItemSelectedImageUIImageImage for the selected list item.
listItemDeSelectedImageUIImageImage for the deselected list item.
backgroundColorUIColorBackground color.
borderWidthCGFloatBorder width.
borderColorUIColorBorder color.
cornerRadiusCometChatCornerStyleCorner radius.
titleColorUIColorText color for the title.
titleFontUIFontFont for the title.
largeTitleColorUIColorText color for large titles.
largeTitleFontUIFontFont for large titles.
navigationBarTintColorUIColorBackground color for the navigation bar.
navigationBarItemsTintColorUIColorTint color for navigation bar items.
errorTitleTextFontUIFontFont for the error title.
errorTitleTextColorUIColorText color for the error title.
errorSubTitleFontUIFontFont for the error subtitle.
errorSubTitleTextColorUIColorText color for the error subtitle.
retryButtonTextColorUIColorText color for the retry button.
retryButtonTextFontUIFontFont for the retry button text.
retryButtonBackgroundColorUIColorBackground color for the retry button.
retryButtonBorderColorUIColorBorder color for the retry button.
retryButtonBorderWidthCGFloatBorder width for the retry button.
retryButtonCornerRadiusCometChatCornerStyleCorner radius for the retry button.
emptyTitleTextFontUIFontFont for the empty state title.
emptyTitleTextColorUIColorText color for the empty state title.
emptySubTitleFontUIFontFont for the empty state subtitle.
emptySubTitleTextColorUIColorText color for the empty state subtitle.
tableViewSeparatorUIColorColor for the table view separator.
backIconUIImageIcon for the back button.
backIconTintUIColorTint color for the back icon.
incomingCallIconUIImageIcon for incoming calls.
incomingCallIconTintUIColorTint color for the incoming call icon.
outgoingCallIconUIImageIcon for outgoing calls.
outgoingCallIconTintUIColorTint color for the outgoing call icon.
missedCallTitleColorUIColorText color for missed call titles.
missedCallIconUIImageIcon for missed calls.
missedCallIconTintUIColorTint color for the missed call icon.
audioCallIconUIImageIcon for audio calls.
audioCallIconTintUIColorTint color for the audio call icon.
videoCallIconUIImageIcon for video calls.
videoCallIconTintUIColorTint color for the video call icon.
separatorColorUIColorColor for separators.
set(callRequestBuilder:)CallLogsRequest.CallLogsBuilderSets the CallLogsBuilder instance for call logs.
hideErrorBoolHides the error state view.
hideNavigationBarBoolHides the navigation bar.
hideLoadingStateBoolHides the loading state view.
hideBackIconBoolHides the back icon in the navigation bar.
set(onItemClick:)(CallLog, IndexPath) -> VoidTriggered when you click on a ListItem.
set(onItemLongClick:)(CallLog, IndexPath) -> VoidTriggered when you long press on a ListItem.
set(onBack:)() -> VoidTriggered when back button is pressed.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(onEmpty:)() -> VoidTriggers when the call logs list is empty.
set(onLoad:)([CallLog]) -> VoidTriggers when call logs are successfully loaded.
set(listItemView:)(CallLog) -> UIViewAssigns a custom ListItem to the CallLogs component.
set(titleView:)(CallLog) -> UIViewSets a custom title view for call log cells.
set(leadingView:)(CallLog) -> UIViewSets a custom leading view for call log cells.
set(subtitleView:)(CallLog) -> UIViewSets a custom subtitle view for call log cells.
set(trailView:)(CallLog) -> UIViewSets a custom trailing view for call log cells.
set(emptyView:)UIViewSets a custom empty state view.
set(errorView:)UIViewSets a custom error view.
set(menus:)[UIBarButtonItem]Sets custom menus to add more options.
avatarStyleAvatarStyleCustomizes the appearance of avatars.

Renamed Properties

NameTypeDescriptionOld Name
set(onItemClick:)(CallLog, IndexPath) -> VoidTriggered when you click on a ListItem.setOnItemClick
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.set(onError:)

Removed Properties

NameTypeDescription
backButtonFontUIFontSets the font for the back button.
backButtonIconUIImageSets the icon for the back button.
backButtonTintUIColorSets the tint for the back button.
backButtonTitleString?Sets the title for the back button.
backButtonTitleColorUIColorSets the title color for the back button.
background[CGColor]?Sets the background.
cornerCometChatCornerStyleSets the corner style.
emptyStateTextStringSets the text for empty state.
emptyStateTextFontUIFontSets the font for empty state text.
errorStateTextStringSets the text for error state.
errorStateTextColorUIColorSets the text color for error state.
errorStateTextFontUIFontSets the font for error state text.
searchBackgroundUIColorSets the background for the search bar.
searchBarHeightCGFloatSets the height for the search bar.
searchBorderColorUIColorSets the border color for the search bar.
searchCancelButtonFontUIFontSets the font for the search cancel button.
searchCancelButtonTintUIColorSets the tint for the search cancel button.
searchClearIconUIImageSets the icon for the search clear button.
searchCornerRadiusCometChatCornerStyleSets the corner radius for the search bar.
searchIconUIImage?Sets the icon for the search bar.
searchPlaceholderStringSets the placeholder for the search bar.
searchTextColorUIColorSets the color for the search text.
searchTextFontUIFontSets the font for the search text.
set(title:mode:)String, UINavigationItem.LargeTitleDisplayModeSets the title for the title bar.
titleColorUIColorSets the color for the title (now part of style).
titleFontUIFontSets the font for the title (now part of style).
hide(errorText:)BoolHides the error text.
hide(search:)BoolHides the search bar.
hide(separator:)BoolHides the separator.
callStatusTextFontUIFontSets the call status font.
missedCallTitleTintUIColorSets the missed call color.
callTimeTextFontUIFontSets the call time font.
dateSeparatorTextFontUIFontSets the date separator font.
emptyStateTextFontUIFontSets the empty state font (now emptyTitleTextFont).
errorStateTextFontUIFontSets the error state font (now errorTitleTextFont).
callStatusTextColorUIColorSets the call status color.
callStatusIconTintUIColorSets the call status icon tint.
callTimeTextColorUIColorSets the call time color.
dateSeparatorTextColorUIColorSets the date separator color.
infoIconTintUIColorSets the info icon tint.
listItemStyleListItemStyleStyles to apply to each call log item.

Call Buttons

New Properties

NameTypeDescription
videoCallIconTintUIColorTint color for the video call icon.
videoCallTextFontUIFontFont for the video call button text.
videoCallTextColorUIColorColor for the video call button text.
videoCallButtonBackgroundUIColorBackground color for the video call button.
videoCallButtonCornerRadiusCometChatCornerStyleCorner radius for the video call button.
videoCallButtonBorderCGFloatBorder width for the video call button.
videoCallButtonBorderColorUIColorBorder color for the video call button.
videoCallIconUIImageIcon for the video call button.
audioCallIconTintUIColorTint color for the audio call icon.
audioCallTextFontUIFontFont for the audio call button text.
audioCallTextColorUIColorColor for the audio call button text.
audioCallButtonBackgroundUIColorBackground color for the audio call button.
audioCallButtonCornerRadiusCometChatCornerStyleCorner radius for the audio call button.
audioCallButtonBorderCGFloatBorder width for the audio call button.
audioCallButtonBorderColorUIColorBorder color for the audio call button.
audioCallIconUIImageIcon for the audio call button.
hideVideoCallButtonBoolHides the video call button.
hideVoiceCallButtonBoolHides the voice call button.
set(user:)UserSets the User object for CometChatCallButtons.
set(group:)GroupSets the Group object for CometChatCallButtons.
set(outgoingCallConfiguration:)OutgoingCallConfigurationSets the configuration for outgoing calls.
set(customSoundForCalls:)URLSets a custom sound for incoming and outgoing calls.
set(callSettingBuilder:)(CallType, [CallUser]) -> CallSettingsFunction to build call settings based on call type and participants.
set(onVoiceCallClick:)(User?, Group?) -> VoidOverride the action triggered upon pressing the voice call button.
set(onVideoCallClick:)(User?, Group?) -> VoidOverride the action triggered upon pressing the video call button.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(controller:)UIViewControllerSets the controller (mandatory for proper configuration).
styleCallButtonStyleCustomizes the appearance of the CallButtons component.

Renamed Properties

NameTypeDescriptionOld Name
hideVideoCallButtonBoolHides the video call button.hide(videoCall:)
hideVoiceCallButtonBoolHides the voice call button.hide(voiceCall:)
set(onVoiceCallClick:)(User?, Group?) -> VoidOverride the action triggered upon pressing the voice call button.setOnVoiceCallClick
set(onVideoCallClick:)(User?, Group?) -> VoidOverride the action triggered upon pressing the video call button.setOnVideoCallClick
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.setOnError

Removed Properties

NameTypeDescription
set(background:)UIColorSets the background color.
set(textFont:)UIFontSets the font of the text.
set(textColor:)UIColorSets the color of the text.
set(cornerRadius:)CometChatCornerStyleSets the corner radius.
set(borderColor:)UIColorSets the color of the border.
set(borderWidth:)CGFloatSets the width of the border.
set(iconBackground:)UIColorSets the background of the icon.
set(iconBorder:)CGFloatSets the border of the icon.
set(iconCornerRadius:)CGFloatSets the corner radius of the icon.
set(iconTint:)UIColorSets the tint of the icon.
set(callButtonsStyle:)ButtonStyleSets the button style for call buttons.
set(isCenterAligned:)BoolSets the alignment of the buttons.
set(videoCallIcon:)UIImageSets the icon for the video call button (now part of style).
set(videoCallIconText:)StringSets the text for the video call button.
set(voiceCallIcon:)UIImageSets the icon for the voice call button (now part of style).
set(voiceCallIconText:)StringSets the text for the voice call button.

Incoming Call

New Properties

NameTypeDescription
overlayBackgroundColorUIColorBackground color for the overlay.
acceptButtonBackgroundColorUIColorBackground color for the accept button.
rejectButtonBackgroundColorUIColorBackground color for the reject button.
acceptButtonTintColorUIColorTint color for the accept button.
rejectButtonTintColorUIColorTint color for the reject button.
acceptButtonImageUIImageIcon image for the accept button.
rejectButtonImageUIImageIcon image for the reject button.
acceptButtonCornerRadiusCometChatCornerStyleSets corner radius for accept button.
rejectButtonCornerRadiusCometChatCornerStyleSets corner radius for reject button.
acceptButtonBorderWidthCGFloatSets border width for accept button.
rejectButtonBorderWidthCGFloatSets border width for reject button.
acceptButtonBorderColorUIColorSets border color for accept button.
rejectButtonBorderColorUIColorSets border color for reject button.
backgroundColorUIColorBackground color for the call view.
cornerRadiusCometChatCornerStyleCorner radius for the view.
borderColorUIColorBorder color for the view.
borderWidthCGFloatBorder width for the view.
callLabelColorUIColorText color for the call label.
callLabelFontUIFontFont for the call label.
nameLabelColorUIColorText color for the name label.
nameLabelFontUIFontFont for the name label.
disableSoundForCallsBoolDisables sound for incoming calls.
set(customSoundForCalls:)URLSets a custom sound for incoming calls.
set(call:)CallSets the call object for the incoming call.
set(onAcceptClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the accept button.
set(onCancelClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the reject button.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(listItemView:)(Call) -> UIViewAssigns a custom view to the incoming call item view.
set(leadingView:)(Call) -> UIViewSets a custom leading view for incoming call.
set(titleView:)(Call) -> UIViewSets a custom title view for incoming call.
styleIncomingCallStyleCustomizes the appearance of the IncomingCall component.
avatarStyleAvatarStyleCustomizes the appearance of avatars.

Renamed Properties

NameTypeDescriptionOld Name
set(onAcceptClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the accept button.setOnAcceptClick
set(onCancelClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the reject button.setOnCancelClick
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.setOnError

Removed Properties

NameTypeDescription
set(background:)UIColorSets the background color for IncomingCall.
set(cornerRadius:)CometChatCornerStyleSets the corner radius for IncomingCall.
set(borderWidth:)CGFloatSets the border width for IncomingCall.
set(borderColor:)UIColorSets the border color for IncomingCall.
set(titleColor:)UIColorSets the title color for IncomingCall.
set(titleFont:)UIFontSets the title font for IncomingCall.
set(subtitleColor:)UIColorSets the subtitle color for IncomingCall.
set(subtitleFont:)UIFontSets the subtitle font for IncomingCall.
set(incomingCallStyle:)IncomingCallStyleSets the incoming call style.
set(avatarStyle:)AvatarStyleSets the avatar style.
set(user:)UserSets the user object for the incoming call.
set(acceptButtonIcon:)UIImageSets the icon for the accept button (now part of style).
set(declineButtonIcon:)UIImageSets the icon for the decline button (now part of style).

Outgoing Call

New Properties

NameTypeDescription
backgroundColorUIColorSets the background color for the outgoing call view.
borderColorUIColorSets the border color for the outgoing call view.
borderWidthCGFloatSets the border width for the outgoing call view.
cornerRadiusCometChatCornerStyleSets the corner radius for the outgoing call view.
nameTextColorUIColorSets the text color for the name label in the outgoing call view.
nameTextFontUIFontSets the font for the name label in the outgoing call view.
callTextColorUIColorSets the text color for the call label in the outgoing call view.
callTextFontUIFontSets the font for the call label in the outgoing call view.
declineButtonBackgroundColorUIColorSets the background color for the decline button in the outgoing call view.
declineButtonIconTintUIColorSets the tint color for the decline button icon.
declineButtonIconUIImageSets the icon for the decline button.
declineButtonCornerRadiusCometChatCornerStyleSets the corner radius for decline button.
declineButtonBorderColorUIColorSets the border color for decline button.
declineButtonBorderWidthCGFloatSets the border width for decline button.
nameLabelUIFontSets the font for the name label.
callingLabelUIFontSets the font for the call label.
disableSoundForCallsBoolDisables sound for outgoing calls.
set(customSoundForCalls:)URLSets a custom sound for outgoing calls.
set(call:)CallSets the Call object for CometChatOutgoingCall.
set(onCancelClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the cancel button.
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.
set(avatarView:)(Call) -> UIViewSets a custom avatar view for outgoing call.
set(cancelView:)(Call) -> UIViewSets a custom cancel button view for outgoing call.
set(titleView:)(Call) -> UIViewSets a custom title view for outgoing call.
set(subtitleView:)(Call) -> UIViewSets a custom subtitle view for outgoing call.
styleOutgoingCallStyleCustomizes the appearance of the OutgoingCall component.
avatarStyleAvatarStyleCustomizes the appearance of avatars.

Renamed Properties

NameTypeDescriptionOld Name
set(onCancelClick:)(Call, UIViewController?) -> VoidOverride the action triggered upon pressing the cancel button.setOnCancelClick
set(onError:)(CometChatException) -> VoidTriggered when an error occurs.setOnError

Removed Properties

NameTypeDescription
set(background:)UIColorSets the background color.
set(cornerRadius:)CometChatCornerStyleSets the corner radius.
set(borderWidth:)CGFloatSets the border width.
set(borderColor:)UIColorSets the border color.
set(titleColor:)UIColorSets the title color.
set(titleFont:)UIFontSets the title font.
set(subtitleColor:)UIColorSets the subtitle color.
set(subtitleFont:)UIFontSets the subtitle font.
set(outgoingCallStyle:)OutgoingCallStyleSets the outgoing call style.
set(avatarStyle:)AvatarStyleSets the avatar style.
set(buttonStyle:)ButtonStyleSets the button style for outgoing call.
disable(soundForCalls:)BoolDisables the default sound for calls.
set(declineButtonIcon:)UIImageSets the icon for the decline button (now part of style).
set(user:)UserSets the User object for CometChatOutgoingCall.