Message search
Message search is a feature that allows users to search for messages within a specific channel. It retrieves a list of messages that contains a search query from group channels joined by a user. You can search for either an exact match or a partial match.
Users can use this feature through the search bar in the message search view. When they search for a keyword in the search bar, the message search view will display the search results as shown below. Users can locate the message that they’re looking for by selecting the specific result.
Note : To learn more about implementing message search, refer to Search messages.
Customize the UI for message search
The UI for message search can be customized through SBUMessageSearchTheme and SBUMessageSearchResultCellTheme in the SBUTheme, SBUStringSet and SBUIconSet.
SBUMessageSearchTheme
The following table shows customizable theme properties of message search.
| Category | Property | Description |
|---|---|---|
Navigation bar | navigationBarTintColor | The tint color of the navigation bar. |
Navigation bar | navigationBarShadowColor | The shadow color of the navigation bar. |
Status bar | statusBarStyle | The style of the status bar. |
View | backgroundColor | The background color of the channel list view. |
Search Field | searchTextColor | The text color of the search text field. |
Search Field | searchTextFont | The font of the search text field. |
Search Field | searchTextBackgroundColor | The background color of the search text field. |
Search Field | searchPlaceholderColor | The text color of the search text field. |
Search Field | searchIconTintColor | The tint color of the search icon. |
Search Field | clearIconTintColor | The tint color of the clear icon. |
Search Field | cancelButtonTintColor | The tint color of the cancel button. |
SBUMessageSearchResultCellTheme
The following table shows customizable theme properties of message search results.
| Category | Property | Description |
|---|---|---|
View | backgroundColor | The background color of the cell. |
View | separatorLineColor | The color of the separator line. |
Title | titleFont | The font of the title element. |
Title | titleTextColor | The text color of the title element. |
Message | descriptionFont | The font of the message element. |
Message | descriptionTextColor | The text color of the message element. |
File Message | fileMessageFont | The font of the file name in the file message. |
File Message | fileMessageTextColor | The text color of the file name in the file message. |
File Message | fileMessageIconBackgroundColor | The background color of the file icon. |
File Message | fileMessageIconTintColor | The tint color of the file icon. |
Updated time | updatedAtFont | The font of the updated time. |
Updated time | updatedAtTextColor | The text color of the updated time. |
SBUStringSet
The following table lists customizable properties of SBUStringSet that can be modified to customize message search. The SBUStringSet is a set of strings used to compose the screen. You need to modify the stringSet values in advance if you want to make changes to the screen.
| Property name | Description |
|---|---|
Search | A placeholder text in the search text field. |
ChannelSettings_Search | A text for search menu in channel settings. |
Empty_Search_Result | A text indicating that there are no search results. |
SBUIconSet
The following table shows properties that can be modified to customize message search icons.
| Icon | Image | Description |
|---|---|---|
iconSearch | Search |