stream-chat-android-ui-common/io.getstream.chat.android.ui.common.utils

Package-level declarations

Types

AttachmentConstants

object AttachmentConstants

Various constants regarding default attachment limits.

ChannelNameFormatter

fun interface ChannelNameFormatter

An interface that generates a name for the given channel.

EmojiUtil

object EmojiUtil

Util used for detecting emojis inside messages.

ExpandableList

data class ExpandableList<T>(items: List<T>, minimumVisibleItems: Int = items.size, val isCollapsed: Boolean = true) : List<T>

A read-only, immutable list wrapper that supports expandable and collapsible behavior.

GiphyInfo

data class GiphyInfo(val url: String, @Px val width: Int, @Px val height: Int)

Contains extra information about Giphy attachments.

GiphyInfoType

enum GiphyInfoType : Enum<GiphyInfoType>

Enum class that holds a value used to obtain Giphy images of different quality level.

GiphySizingMode

enum GiphySizingMode : Enum<GiphySizingMode>

Sets the way in which Giphy container sizing is determined.

MediaStringUtil

object MediaStringUtil

PollsConstants

object PollsConstants

Constants related to polls.

Utils

open class Utils

Properties

GIPHY_INFO_DEFAULT_HEIGHT_DP

const val GIPHY_INFO_DEFAULT_HEIGHT_DP: Int = 200

Default height used for Giphy Images if no width metadata is available.

GIPHY_INFO_DEFAULT_WIDTH_DP

const val GIPHY_INFO_DEFAULT_WIDTH_DP: Int = 200

Default width used for Giphy Images if no width metadata is available.

Functions

adjustColorBrightness

fun adjustColorBrightness(color: Int, factor: Float): Int

Used for gradient color adjustment when the user doesn't have an image.

canBlockUser

fun canBlockUser(blockUserEnabled: Boolean, currentUser: User?, message: Message): Boolean

Determines whether the user who sent the given message can be blocked.

canCopyMessage

fun canCopyMessage(copyTextEnabled: Boolean, message: Message): Boolean

Determines whether the given message can be copied to the clipboard.

canDeleteMessage

fun canDeleteMessage(deleteMessageEnabled: Boolean, currentUser: User?, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether the given message can be deleted.

canEditMessage

fun canEditMessage(editMessageEnabled: Boolean, currentUser: User?, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether the given message can be edited.

canFlagMessage

fun canFlagMessage(flagEnabled: Boolean, currentUser: User?, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether the given message can be flagged.

canMarkAsUnread

fun canMarkAsUnread(markAsUnreadEnabled: Boolean, currentUser: User?, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether messages in the channel can be marked as unread.

canMuteUser

fun canMuteUser(muteUserEnabled: Boolean, currentUser: User?, message: Message, channel: Channel): Boolean

Determines whether the user who sent the given message can be muted.

canPinMessage

fun canPinMessage(pinMessageEnabled: Boolean, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether the given message can be pinned or unpinned.

canReplyToMessage

fun canReplyToMessage(replyEnabled: Boolean, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether a reply (quote) can be made to the given message.

canRetryMessage

fun canRetryMessage(retryMessageEnabled: Boolean, currentUser: User?, message: Message): Boolean

Determines whether the given message can be retried.

canThreadReplyToMessage

fun canThreadReplyToMessage(threadsEnabled: Boolean, isInThread: Boolean, message: Message, ownCapabilities: Set<String>): Boolean

Determines whether a thread reply can be made to the given message.

emptyExpandableList

fun <T> emptyExpandableList(): ExpandableList<T>

Creates an empty read-only ExpandableList instance.

giphyInfo

fun Attachment.giphyInfo(field: GiphyInfoType): GiphyInfo?

Returns an object containing extra information about the Giphy image based on its type.

isPermissionDeclared

fun Context.isPermissionDeclared(permission: String): Boolean

Returns if we need to check for the given permission or not.

openSystemSettings

fun Context.openSystemSettings()

Forwards user to the application settings screen.

shareLocalFile

fun Context.shareLocalFile(uri: Uri, mimeType: String? = null, text: String? = null)

Share a local file.