Sendbird Chat/com.sendbird.android.message

Package-level declarations

Types

AdminMessage

class AdminMessage : BaseMessage

Object representing an admin message.

Answer

data class Answer(val formFieldKey: String, val value: String)

Represents an answer to a FormField.

AppleCriticalAlertOptions

class AppleCriticalAlertOptions @JvmOverloads constructor(val name: String = DEFAULT_NAME, val volume: Double = DEFAULT_VOLUME)

A class that can be used to send apple's critical alert.

BaseFileMessage

sealed class BaseFileMessage : BaseMessage

BaseMessage

abstract class BaseMessage

Base class for messages.

CustomizableMessage

open class CustomizableMessage @JvmOverloads constructor(channelUrl: String, messageId: Long, createdAt: Long, val requestId: String = "") : BaseMessage

This class is to provide a customizable BaseMessage class so that a custom message object such as a timeline or bookmark message can be used with other actual BaseMessage objects in a single List<BaseMessage>.

Emoji

class Emoji

Objects representing a emoji.

EmojiCategory

class EmojiCategory

Objects representing a category of emoji.

EmojiContainer

class EmojiContainer

Objects representing emoji information.

Feedback

data class Feedback

User's feedback data about the message

FeedbackRating

sealed class FeedbackRating

The feedback rating the user gave.

FeedbackStatus

enum FeedbackStatus : Enum<FeedbackStatus>

The status of the feedback in the message.

FileMessage

class FileMessage : BaseFileMessage

Object representing a file.

Form

data class Form(val messageId: Long, val formKey: String, val formFields: List<FormField>, val isSubmitted: Boolean)

Represents a form.

FormField

data class FormField(val messageId: Long, val key: String, val title: String, val inputType: FormFieldInputType, val regex: String? = null, val placeholder: String? = null, val required: Boolean, val answer: Answer? = null)

Represents a form field where users can enter values.

FormFieldInputType

enum FormFieldInputType : Enum<FormFieldInputType>

Represents a input type of a FormField.

MentionType

enum MentionType : Enum<MentionType>

Mention type.

MessageMetaArray

class MessageMetaArray @JvmOverloads constructor(val key: String, value: List<String> = emptyList())

Represents meta array of BaseMessage. Meta array contains key(String), value(List<String>).

MessageReviewInfo

class MessageReviewInfo

Represents a message review history.

MessageReviewStatus

enum MessageReviewStatus : Enum<MessageReviewStatus>

Represents the status of a message review.

MultipleFilesMessage

class MultipleFilesMessage : BaseFileMessage

File message object that contains multiple UploadedFileInfos.

NotificationMessageStatus

enum NotificationMessageStatus : Enum<NotificationMessageStatus>

Notification message status This status is only affected to the notification message.

NotificationPriority

enum NotificationPriority : Enum<NotificationPriority>

Notification priority This value can be set when the notification message is sent and default value is NORMAL

OGImage

class OGImage

Represents a OGImage of OGMetaData. For Specifications, see https://ogp.me/.

OGMetaData

class OGMetaData

Represents a OGMetaData of a url. For Specifications, see https://ogp.me/. Currently we only support images.

OriginalMessageInfo

class OriginalMessageInfo

When the message has reviewed, then the new message will be created. And the new message contains the original message's information.

PinnedMessage

class PinnedMessage

Represents a pinned message in a channel.

Plugin

data class Plugin

Contains plugin information of a UserMessage.

PushNotificationDeliveryOption

enum PushNotificationDeliveryOption : Enum<PushNotificationDeliveryOption>

Push options for messages. BaseMessageCreateParams.pushNotificationDeliveryOption If the option is DEFAULT, push message will work with the receiver's push settings. SendbirdChat.setDoNotDisturb If the option is PushNotificationDeliveryOption.SUPPRESS, push message will not be sent.

Reaction

class Reaction : Comparable<Reaction>

Objects representing a reaction.

ReactionEvent

class ReactionEvent

Objects representing a reaction event.

ReactionEventAction

enum ReactionEventAction : Enum<ReactionEventAction>

The ReactionEvent action state.

ReplyType

enum ReplyType : Enum<ReplyType>

ReplyType to be used in loading messages.

SendingStatus

enum SendingStatus : Enum<SendingStatus>

Represents message sending status.

ThreadInfo

class ThreadInfo

Represents a thread info of a message.

ThreadInfoUpdateEvent

class ThreadInfoUpdateEvent

Objects representing a thread info event.

Thumbnail

class Thumbnail

Represents image thumbnail. Currently this is valid only for image files. Thumbnails can be generated when you send file through

ThumbnailSize

class ThumbnailSize(maxWidth: Int, maxHeight: Int)

Represents image thumbnail size. Currently this is valid only for image files. Thumbnails can be generated when you send file through BaseChannel.sendFileMessage by passing List of this instance.

UploadableFileInfo

class UploadableFileInfo

It represents the information of the file you want to upload through GroupChannel.sendMultipleFilesMessage.

UploadedFileInfo

class UploadedFileInfo

Represents a file to be shipped in a MultipleFilesMessage.

UserMessage

class UserMessage : BaseMessage

Object representing a user message.