Class FileMessage

Description

Object representing a file message.

Hierarchy

  • default
    • FileMessage

Properties

appleCriticalAlertOptions channelType channelUrl createdAt customType data errorCode extendedMessage extendedMessagePayload? forms isOperatorMessage mentionType mentionedMessageTemplate mentionedUserIds mentionedUsers messageId messageParams messageType metaArrays myFeedback myFeedbackStatus name ogMetaData parentMessage parentMessageId plainUrl reactions replyToChannel reqId requireAuth scheduledInfo sender sendingStatus silent size suggestedReplies threadInfo thumbnails type updatedAt

Accessors

isResendable url

Methods

applyParentMessage applyReactionEvent applyThreadInfoUpdateEvent deleteFeedback getMetaArraysByKeys getThreadedMessagesByTimestamp hasForm isAdminMessage isEqual isFileMessage isIdentical isMultipleFilesMessage isUserMessage markThreadAsRead serialize setPushNotificationEnabled submitFeedback submitForm updateFeedback

Properties

appleCriticalAlertOptions

appleCriticalAlertOptions: null | AppleCriticalAlertOptions = null

The apple critical alert options of the message.

Readonly channelType

channelType: ChannelType = ChannelType.BASE

The ChannelType of the channel this message belongs to.

Readonly channelUrl

channelUrl: string

The channel URL of the channel this message belongs to.

createdAt

createdAt: number = 0

The creation time of the message in milliseconds.

customType

customType: string

The custom type of the message.

data

data: string

The custom type of the message.

errorCode

errorCode: number = 0

The error code of them message if the sendingStatus is FAILED.

extendedMessage

extendedMessage: object = {}

The template for the message.

Optional extendedMessagePayload

extendedMessagePayload?: Record<string, unknown>

The datas for the message.

forms

forms: null | Form[] = null

List of Form that allow users to input their information or opinions

isOperatorMessage

isOperatorMessage: boolean = false

Whether the message was sent from an operator.

mentionType

mentionType: null | MentionType = null

The mention type. Refer to MentionType.

mentionedMessageTemplate

mentionedMessageTemplate: string

The mentioned message template of the message.

mentionedUserIds

mentionedUserIds: null | string[] = null

The mentioned user ids of the message.

mentionedUsers

mentionedUsers: null | User[] = null

The mentioned users of the message.

messageId

messageId: number

The ID of the message.

messageParams

messageParams: null | FileMessageCreateParams = null

The messageParams object that used for sending this message For more details.

messageType

messageType: MessageType = MessageType.BASE

metaArrays

metaArrays: MessageMetaArray[] = []

Gets an array of meta arrays sorted by chronological order.

myFeedback

myFeedback: null | Feedback = null

My feedback of the message. Not null, if its FeedbackStatus is FeedbackStatus.SUBMITTED Null, if its FeedbackStatus is FeedbackStatus.NOT_APPLICABLE or FeedbackStatus.NO_FEEDBACK/b>.

myFeedbackStatus

myFeedbackStatus: FeedbackStatus = 'NOT_APPLICABLE'

My feedback status of the message.

Readonly name

name: string

Represents the name of the file.

ogMetaData

ogMetaData: null | OGMetaData

The OGMetaData of the message. Might be null if

parentMessage

parentMessage: null | BaseMessage = null

The parent message of this message. Only NonNull if this message is a reply message. It does not contain all properties of the parent message.

parentMessageId

parentMessageId: number

The parent message's ID if this is a reply message.

Readonly plainUrl

plainUrl: string = ''

The plain file URL, which does not contain sendbirdChat.ekey as a parameter. If the file authentication feature is enabled, accessing this plainUrl will be denied.

reactions

reactions: Reaction[] = []

The reactions on the message.

replyToChannel

replyToChannel: boolean = false

Determines whether the current message is a replied message and also a message was replied to the channel.

reqId

reqId: string = ''

Readonly requireAuth

requireAuth: boolean = false

scheduledInfo

scheduledInfo: null | ScheduledInfo = null

The scheduled info of the message if this is a scheduled message

Readonly sender

sender: Sender

Sender of the message. This is represented by Sender class.

sendingStatus

sendingStatus: SendingStatus

The sending status of the message.

silent

silent: boolean = false

Checks whether the message is silent or not.

Readonly size

size: number

Represents the size of the file.

suggestedReplies

suggestedReplies: null | string[] = null

The suggested replies of the message.

threadInfo

threadInfo: null | ThreadInfo = null

The thread info of the message.

Readonly thumbnails

thumbnails: Thumbnail[] = []

Represents the thumbnail information of image file.

Readonly type

type: string

Represents the type of the file. MIME preferred.

updatedAt

updatedAt: number = 0

The updated time of the message in milliseconds.

Accessors

isResendable

  • get isResendable(): boolean

  • Whether the message is resendable. Used only if the message is failed/canceled to send.

    Returns boolean

url

  • get url(): string

  • The file URL. If the file encryption feature is enabled, this will have sendbirdChat.eKey combined with the plainUrl so the file can be accessed. For caching the file, it is recommended to use plainUrl as the key of the file cache.

    Returns string

Methods

applyParentMessage

  • Parameters

    Returns boolean

    Description

    When parent message is updated, you can update the child message's parent message through this method. If you use MessageCollection, messages in the collection are automatically updated, so don't need to call it.

applyReactionEvent

  • Parameters

    Returns void

    Description

    Applies ReactionEvent to message.

applyThreadInfoUpdateEvent

  • Parameters

    Returns boolean

    Description

    Applies ThreadInfoUpdateEvent to a message.

deleteFeedback

  • Parameters

    • feedbackId: number

    Returns Promise<void>

    Description

    Deletes the feedback for the message. The feedback can be deleted only when the FeedbackStatus is FeedbackStatus.SUBMITTED.

getMetaArraysByKeys

getThreadedMessagesByTimestamp

  • Parameters

    Returns Promise<{
        parentMessage: BaseMessage;
        threadedMessages: BaseMessage[];
    }>

    Description

    Retrieves the threaded replies of the current message depending on the timestamp. If the current message doesn’t have replies, the result is an empty list.

hasForm

  • Returns this is AdminMessage

    Description

    Whether the message has form.

isAdminMessage

isEqual

  • Parameters

    • message: default

    Returns boolean

    Description

    Whether the given message is equal in all the values of this message.

isFileMessage

isIdentical

  • Parameters

    • message: default

    Returns boolean

isMultipleFilesMessage

isUserMessage

markThreadAsRead

  • Returns Promise<void>

    Description

    Marks the message thread as read.

serialize

setPushNotificationEnabled

  • Parameters

    • pushEnabled: boolean

    Returns Promise<void>

    Description

    Sets push notification enabled for the thread.

submitFeedback

  • Parameters

    • data: Pick<Feedback, "rating" | "comment">

    Returns Promise<void>

    Description

    Submits the feedback for the message. The feedback can be submitted only when the FeedbackStatus is FeedbackStatus.NO_FEEDBACK.

submitForm

  • Parameters

    • data: {
          answers?: Record<string, string>;
          formId?: string;
      }
      • Optional answers?: Record<string, string>
      • Optional formId?: string

    Returns Promise<void>

    Deprecated

    since v4.10.6. Use submitForm({ form: Form }) instead.

updateFeedback

  • Parameters

    Returns Promise<void>

    Description

    Updates the feedback for the message. The feedback can be updated only when the FeedbackStatus is FeedbackStatus.SUBMITTED.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc