Matches the default Stream CDN hosts (imgix and stream-io-cdn). Shared with AttachmentHelper so the two can't drift. Anchored on the host only — resizing of custom/proxied Stream CDN domains is opted into via the cdnHost parameter of createResizedStreamCdnImageUrl, mirroring iOS' StreamCDNRequester(cdnHost:).

uploadId

val Attachment.uploadId: String?

Retrieves the upload ID of the attachment.

waveformData

val Attachment.waveformData: List<Float>?

Waveform data of the attachment.

Functions

asLiveData

fun <T> Flow<T>.asLiveData(): LiveData<T>

Creates a LiveData that has values collected from the original Flow.

cidToTypeAndId

fun String.cidToTypeAndId(): Pair<String, String>

Parses CID of channel to channelType and channelId.

countUnreadMentionsForUser

fun Channel.countUnreadMentionsForUser(user: User): Int

Counts messages in which user is mentioned. The method relies on the Channel.messages list and doesn't do any API call. Therefore, the count might be not reliable as it relies on the local data.

createResizedStreamCdnImageUrl

fun String.createResizedStreamCdnImageUrl(@FloatRange(from = 0.0, to = 1.0, fromInclusive = false) resizedWidthPercentage: Float, @FloatRange(from = 0.0, to = 1.0, fromInclusive = false) resizedHeightPercentage: Float, resizeMode: StreamCdnResizeImageMode? = null, cropMode: StreamCdnCropImageMode? = null): String

Generates a string URL with Stream CDN image resizing query parameters added to it. Once this URL is called, Stream's CDN will generate a resized image which is accessible using the link returned by this function.

fun String.createResizedStreamCdnImageUrl(maxImagePixels: Long, resizeMode: StreamCdnResizeImageMode? = null, cropMode: StreamCdnCropImageMode? = null, cdnHost: String? = null): String

Generates a URL with Stream CDN resizing parameters that cap the image to maxImagePixels total pixels (width × height), preserving aspect ratio and never upscaling. Mirrors the iOS SDK's imageAttachmentMaxPixels. Only affects images served from a Stream CDN host (see cdnHost) that carry original width (ow) and height (oh) params; any other URL, or one already at/under the budget, is returned unchanged.

currentUserUnreadCount

fun Channel.currentUserUnreadCount(currentUserId: UserId? = ChatClient.instance().getCurrentUser()?.id): Int

Returns the number of unread messages in the channel for the current user.

deliveredReadsOf

fun Channel.deliveredReadsOf(message: Message): List<ChannelUserRead>

Returns a list of ChannelUserRead objects representing which ones have delivered the given message.

enrichWithCid

fun Message.enrichWithCid(newCid: String): Message

Enriches the message with the given newCid. Sets the Message.cid and the Message.replyTo cid to the newCid value.

getCreatedAtOrDefault

fun Message.getCreatedAtOrDefault(default: Date): Date

getCreatedAtOrNull

fun Message.getCreatedAtOrNull(): Date?

getCreatedAtOrThrow

fun Message.getCreatedAtOrThrow(): Date

getMembersExcludingCurrent

fun Channel.getMembersExcludingCurrent(currentUser: User? = ChatClient.instance().getCurrentUser()): List<Member>

Returns a list of members of the channel excluding the currently logged in user.

getNonNullString

inline fun SharedPreferences.getNonNullString(key: String, defaultValue: String): String

Unlike the getString method it delegates to, this method requires a non-null default value, and therefore guarantees to return a non-null String.

getStreamCdnHostedImageDimensions

fun String.getStreamCdnHostedImageDimensions(): StreamCdnOriginalImageDimensions?

Returns StreamCdnOriginalImageDimensions if the image is hosted by Stream's CDN and is resizable, otherwise returns null.

getUsersExcludingCurrent

fun Channel.getUsersExcludingCurrent(currentUser: User? = ChatClient.instance().getCurrentUser()): List<User>

Returns a list of users that are members of the channel excluding the currently logged in user.

isAnonymousChannel

fun Channel.isAnonymousChannel(): Boolean

Checks if the channel is an anonymous channel (without name).

isArchive

fun Channel.isArchive(): Boolean

Checks if the channel is archived or not for the current user.

isMutedFor

fun Channel.isMutedFor(user: User): Boolean

Checks if Channel is muted for user.

isPinned

fun Channel.isPinned(): Boolean

Checks if the channel is pinned or not for the current user.

isStreamCdnHosted

fun String.isStreamCdnHosted(cdnHost: String? = null): Boolean

Returns whether this URL is served from a Stream CDN host that understands resizing query parameters.

lowerCamelCaseToGetter

fun String.lowerCamelCaseToGetter(): String

Converts a string written in lower camel case to a getter method name. Ex: "camelCase" -> "getCamelCase".

readsOf

fun Channel.readsOf(message: Message): List<ChannelUserRead>

Returns a list of ChannelUserRead objects representing which ones have read the given message.

snakeToLowerCamelCase

fun String.snakeToLowerCamelCase(): String

Converts string written in snake case to String in camel case with the first symbol in lower case. For example string "created_at_some_time" is converted to "createdAtSomeTime".

syncUnreadCountWithReads

fun Channel.syncUnreadCountWithReads(currentUserId: UserId? = ChatClient.instance().getCurrentUser()?.id): Channel

Synchronizes the unread count of the channel with the read state of the current user.

updateFailedMessage

fun Message.updateFailedMessage(error: Error): Message

Updates a message that whose request (Edition/Delete/Reaction update...) has failed.

updateMessageOnlineState

fun Message.updateMessageOnlineState(isOnline: Boolean): Message

Update the online state of a message.