SceytChatUIKitConfig — Full Configuration Reference

SceytChatUIKitConfig is the central configuration object for the Sceyt Chat Android UIKit. It is accessible via SceytChatUIKit.config and should be configured before calling connect(). All properties use sensible defaults so only the fields you need to override must be specified. Sub-configuration objects (such as QueryLimits and PresenceConfig) are lazily initialised, meaning they are created on first access and can be replaced wholesale or mutated in place. Package: com.sceyt.chatuikit.config

SceytChatUIKit.config.apply {
    syncChannelsAfterConnect = true
    hardDeleteMessageForAll  = false
    messageReactionPerUserLimit = 4
    queryLimits = QueryLimits(messageListQueryLimit = 30)
}

Query Limits

queryLimits

QueryLimits

Controls the page sizes used in every list query. All fields are annotated @IntRange(1, 50).

SceytChatUIKit.config.queryLimits = QueryLimits(
    channelListQueryLimit        = 20,
    channelMemberListQueryLimit  = 30,
    userListQueryLimit           = 30,
    messageListQueryLimit        = 50,
    attachmentListQueryLimit     = 20,
    reactionListQueryLimit       = 30,
    unreadMentionsListQueryLimit = 30,
    votersListQueryLimit         = 30,
    mutualGroupsQueryLimit       = 10
)

Show QueryLimits fields

channelListQueryLimit

Int

Number of channels fetched per page. Range 1–50. Default: 20.

channelMemberListQueryLimit

Int

Number of channel members fetched per page. Range 1–50. Default: 30.

userListQueryLimit

Int

Number of users fetched per page when searching. Range 1–50. Default: 30.

messageListQueryLimit

Int

Number of messages fetched per page. Range 1–50. Default: 50.

attachmentListQueryLimit

Int

Number of attachments fetched per page in the media/file gallery. Range 1–50. Default: 20.

reactionListQueryLimit

Int

Number of reactions fetched per page in the reaction voter list. Range 1–50. Default: 30.

unreadMentionsListQueryLimit

Int

Number of unread mention IDs fetched per request. Range 1–50. Default: 30.

votersListQueryLimit

Int

Number of poll voters fetched per page. Range 1–50. Default: 30.

mutualGroupsQueryLimit

Int

Number of mutual groups fetched when viewing another user’s profile. Range 1–50. Default: 10.

Presence

presenceConfig

PresenceConfig

Defines the default presence state and status text sent to the server when the user connects.

SceytChatUIKit.config.presenceConfig = PresenceConfig(
    defaultPresenceState  = PresenceState.Online,
    defaultPresenceStatus = "Available"
)

Show PresenceConfig fields

defaultPresenceState

PresenceState

The PresenceState set automatically on connect. Default: PresenceState.Online.

defaultPresenceStatus

String

The status message string sent alongside the presence state. Default: "".

Channel URI

channelURIConfig

ChannelURIConfig

Governs validation rules for public-channel URIs (handles/slugs).

SceytChatUIKit.config.channelURIConfig = ChannelURIConfig(
    prefix    = "@",
    minLength = 5,
    maxLength = 50,
    regex     = Regex("^[a-zA-Z0-9_]*\$")
)

Show ChannelURIConfig fields

prefix

String

Display prefix prepended to URIs in the UI. Default: "@".

minLength

Int

Minimum allowed URI length (excluding prefix). Default: 5.

maxLength

Int

Maximum allowed URI length. Default: 50.

regex

Regex

Regular expression used to validate URI characters. Default: ^[a-zA-Z0-9_]*$.

Channel Types

channelTypesConfig

ChannelTypesConfig

Maps logical channel-type names to the string identifiers used in the Sceyt API.

SceytChatUIKit.config.channelTypesConfig = ChannelTypesConfig(
    direct    = "direct",
    group     = "group",
    broadcast = "broadcast"
)

Show ChannelTypesConfig fields

direct

String

Type identifier for 1-to-1 direct channels. Default: "direct".

group

String

Type identifier for group channels. Default: "group".

broadcast

String

Type identifier for broadcast channels. Default: "broadcast".

Member Roles

memberRolesConfig

MemberRolesConfig

Maps logical role names to the string identifiers used in the Sceyt API.

SceytChatUIKit.config.memberRolesConfig = MemberRolesConfig(
    owner       = "owner",
    admin       = "admin",
    participant = "participant",
    subscriber  = "subscriber"
)

Show MemberRolesConfig fields

owner

String

Role granted to the channel creator. Default: "owner".

admin

String

Role for channel administrators. Default: "admin".

participant

String

Role for regular group channel members. Default: "participant".

subscriber

String

Role for read-only broadcast channel subscribers. Default: "subscriber".

Push Notifications

notificationConfig

PushNotificationConfig

Controls push notification registration and display behaviour.

SceytChatUIKit.config.notificationConfig = PushNotificationConfig(
    isPushEnabled                = true,
    suppressWhenAppIsInForeground = true,
    shouldDisplayNotification    = { pushData -> true },
    pushProviders                = listOf(MyFcmProvider())
)

Show PushNotificationConfig fields

isPushEnabled

Boolean

Enables or disables device push token registration. When false the token is never sent to the server. Default: true.

suppressWhenAppIsInForeground

Boolean

When true, system notifications are not displayed while the app is in the foreground. Default: true.

shouldDisplayNotification

(PushData) -> Boolean

A predicate called for each incoming push. Return false to suppress display of that notification. Default: always true.

pushProviders

List<PushDeviceProvider>

Ordered list of PushDeviceProvider implementations. The first provider whose isSupported() returns true is used for token registration. Default: empty list.

Voice Recorder

voiceRecorderConfig

VoiceRecorderConfig

Configures audio quality and duration limits for the built-in voice message recorder.

SceytChatUIKit.config.voiceRecorderConfig = VoiceRecorderConfig(
    maxDuration  = VoiceRecorderDuration.MaxDuration(5.minutes.inWholeMilliseconds),
    bitrate      = 32_000,
    simplingRate = 16_000
)

Show VoiceRecorderConfig fields

maxDuration

VoiceRecorderDuration

Maximum recording length. Use VoiceRecorderDuration.Unlimited for no limit, or VoiceRecorderDuration.MaxDuration(ms) to cap to a millisecond value. Default: MaxDuration(5 minutes).

bitrate

Int

Encoding bitrate in bits per second. Default: 32000.

simplingRate

Int

Audio sampling rate in Hz. Default: 16000.

Global Search

globalSearchConfig

GlobalSearchConfig

Tunes the behaviour of the global search screen.

SceytChatUIKit.config.globalSearchConfig.apply {
    userSuggestionsLimit  = 8
    searchInputDebounceMs = 300
    closeBehavior         = GlobalSearchCloseBehavior.OnMessageSent
}

Show GlobalSearchConfig fields

userSuggestionsLimit

Int

Maximum number of user suggestions shown in search results. Default: 8.

searchInputDebounceMs

Long

Milliseconds to wait after the user stops typing before executing the search query. Default: 300.

closeBehavior

GlobalSearchCloseBehavior

Determines when the global search screen auto-closes. Options: Never, OnChannelOpen, OnMessageSent. Default: OnMessageSent.

Channel Invite Deep Link

channelLinkDeepLinkConfig

ChannelInviteDeepLinkConfig?

Optional configuration for generating and parsing channel invite deep links. When null, invite-link features are disabled in the UI.

SceytChatUIKit.config.channelLinkDeepLinkConfig = ChannelInviteDeepLinkConfig(
    scheme     = "https",
    host       = "link.example.com",
    pathPrefix = "/join/"
)
// Produces: https://link.example.com/join/{inviteKey}

Show ChannelInviteDeepLinkConfig fields

scheme

String

URL scheme, e.g. "https" or a custom scheme.

host

String

Domain name for the deep link, e.g. "link.sceyt.com".

pathPrefix

String

Path segment appended before the invite key, e.g. "/join/".

Sync and Message Behaviour

syncChannelsAfterConnect

Boolean

When true, SceytSyncManager automatically synchronises channel and message data after each successful connection. Default: true.

hardDeleteMessageForAll

Boolean

When true, deleting a message performs a hard delete for all participants rather than a soft/local delete. Default: false.

messageEditTimeout

Long

Maximum window in milliseconds after sending a message during which it can be edited. Default: 2 hours (7_200_000 ms).

SceytChatUIKit.config.messageEditTimeout = 1.hours.inWholeMilliseconds

preventDuplicateAttachmentUpload

Boolean

When true, the SDK checks a file checksum before uploading to avoid uploading the same file twice. Default: true.

Media Resizing

avatarResizeConfig

ResizeConfig

Resize settings applied to avatar images before upload. Default: ResizeConfig.Low (720 px, 80% quality).

SceytChatUIKit.config.avatarResizeConfig = ResizeConfig.Medium // 1080 px, 80%

imageAttachmentResizeConfig

ResizeConfig

Resize settings applied to image attachments before upload. Default: ResizeConfig.Medium (1080 px, 80% quality).

Preset	Dimension threshold	Quality
`Low`	720 px	80 %
`Medium`	1080 px	80 %
`High`	1600 px	90 %

videoAttachmentResizeConfig

VideoResizeConfig

Resize settings applied to video attachments before upload. Default: VideoResizeConfig.Medium (1200 px, 80% quality, 30 fps, 1 Mbps bitrate).

Preset	Threshold	Quality	FPS	Bitrate
`Low`	800 px	80 %	30	500 kbps
`Medium`	1200 px	80 %	30	1000 kbps
`High`	1600 px	80 %	30	2000 kbps

Channel List and UI Preferences

channelListOrder

ChannelListOrder

Sort order for the channel list. Uses ChannelListQuery.ChannelListOrder from the Sceyt Chat SDK. Default: ListQueryChannelOrderLastMessage.

defaultReactions

List<String>

The emoji list shown in the quick-reaction strip on messages. Default: ["😎", "😂", "👌", "😍", "👍", "😏"].

SceytChatUIKit.config.defaultReactions = listOf("❤️", "👍", "😂", "😮", "😢", "🙏")

mentionTriggerPrefix

Char

The character that triggers the member-mention suggestion dropdown in the message input. Default: '@'.

Notification and Auto-Delete Options

muteChannelNotificationOptions

MuteNotificationOptions

A fun interface that returns a list of IntervalOption items shown in the mute-notifications picker (e.g. “1 hour”, “8 hours”, “Forever”). Defaults to DefaultMuteNotificationOptions.

SceytChatUIKit.config.muteChannelNotificationOptions = MuteNotificationOptions { context ->
    listOf(
        IntervalOption(context.getString(R.string.mute_1h),   3_600_000L),
        IntervalOption(context.getString(R.string.mute_forever), Long.MAX_VALUE)
    )
}

messageAutoDeleteOptions

AutoDeleteMessagesOptions

A fun interface that returns a list of IntervalOption items for the auto-delete timer picker. Defaults to DefaultAutoDeleteMessagesOptions.

Avatar Colors

defaultAvatarBackgroundColors

AvatarBackgroundColors

A fun interface that returns a list of Int color values used as backgrounds for generated (initials-based) avatars. Defaults to DefaultAvatarBackgroundColors.

SceytChatUIKit.config.defaultAvatarBackgroundColors = AvatarBackgroundColors { context ->
    listOf(
        ContextCompat.getColor(context, R.color.avatar_bg_1),
        ContextCompat.getColor(context, R.color.avatar_bg_2),
    )
}

Mutual Groups

mutualGroupChannelTypes

MutualGroupChannelTypes

A fun interface returning the list of channel type strings to include when fetching mutual groups between two users. Defaults to DefaultMutualGroupChannelTypes.

Limits and Constraints

messageReactionPerUserLimit

Int

Maximum number of distinct reactions a single user can add to one message. Annotated @IntRange(from = 1, to = 6). Default: 6.

messageMultiselectLimit

Int

Maximum number of messages that can be selected at once in multi-select mode. Annotated @IntRange(from = 1, to = 50). Default: 30.

attachmentSelectionLimit

Int

Maximum number of files or media items that can be selected in a single attachment-picker session. Annotated @IntRange(from = 1, to = 50). Default: 20.

Core API

Interactors

Styles & Theming

SceytChatUIKitConfig — Full Configuration Reference

Query Limits

Presence

Channel URI

Channel Types

Member Roles

Push Notifications

Voice Recorder

Global Search

Channel Invite Deep Link

Sync and Message Behaviour

Media Resizing

Channel List and UI Preferences

Notification and Auto-Delete Options

Avatar Colors

Mutual Groups

Limits and Constraints

Build docs developers (and LLMs) love

Core API

Interactors

Styles & Theming

Documentation Index

​Query Limits

​Presence

​Channel URI

​Channel Types

​Member Roles

​Push Notifications

​Voice Recorder

​Global Search

​Channel Invite Deep Link

​Sync and Message Behaviour

​Media Resizing

​Channel List and UI Preferences

​Notification and Auto-Delete Options

​Avatar Colors

​Mutual Groups

​Limits and Constraints

Build docs developers (and LLMs) love

Query Limits

Presence

Channel URI

Channel Types

Member Roles

Push Notifications

Voice Recorder

Global Search

Channel Invite Deep Link

Sync and Message Behaviour

Media Resizing

Channel List and UI Preferences

Notification and Auto-Delete Options

Avatar Colors

Mutual Groups

Limits and Constraints