com.sendbird.android

Class FileMessage

java.lang.Object

com.sendbird.android.BaseMessage

com.sendbird.android.FileMessage

public final class FileMessage
extends BaseMessage

Object representing a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileMessage.RequestState Deprecated. As of 3.0.120, replaced by SendingStatus.
static class	FileMessage.Thumbnail Represents image thumbnail.
static class	FileMessage.ThumbnailSize Represents image thumbnail size.

Nested classes/interfaces inherited from class com.sendbird.android.BaseMessage

BaseMessage.GetMessageHandler, BaseMessage.GetThreadedMessagesHandler, BaseMessage.SendingStatus

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() Returns message text.
FileMessageParams	getMessageParams() returns FileMessageParams object that used for sending this message It's not null when sendingStatus is SendingStatus#PENDING or SendingStatus#FAILED or SendingStatus#CANCELED If else, it will return null
java.lang.String	getName() Returns name of the file.
java.lang.String	getPlainUrl() Returns the plain file URL, which does not contain SendBird.getEkey() as a parameter.
java.util.List<java.lang.String>	getRequestedMentionUserIds() Returns requested mention user ids.
java.lang.String	getRequestId() Returns a file request ID.
FileMessage.RequestState	getRequestState() Deprecated. As of 3.0.120, replaced by BaseMessage.getSendingStatus().
int	getSize() Returns size of the file.
java.util.List<FileMessage.Thumbnail>	getThumbnails() Returns the thumbnail information of image file.
java.lang.String	getType() Returns the type of the file.
java.lang.String	getUrl() Returns the file URL.
java.lang.String	toString()

Methods inherited from class com.sendbird.android.BaseMessage

applyParentMessage, applyReactionEvent, applyThreadInfoUpdateEvent, belongsTo, belongsTo, buildFromSerializedData, buildFromSerializedData, clone, equals, getAllMetaArray, getAllMetaArrays, getAppleCriticalAlertOptions, getChannelUrl, getCreatedAt, getCustomType, getData, getErrorCode, getMentionedMessageTemplate, getMentionedUsers, getMentionType, getMessage, getMessageId, getMessageSurvivalSeconds, getMetaArray, getMetaArrays, getOgMetaData, getParentMessage, getParentMessageId, getParentMessageText, getReactions, getSender, getSendingStatus, getThreadedMessagesByTimestamp, getThreadInfo, getUpdatedAt, hashCode, isGroupChannel, isOpenChannel, isOperatorMessage, isReplyToChannel, isResendable, isSilent, serialize, setAppleCriticalAlertOptions

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMessage

public java.lang.String getMessage()

Returns message text. Always set to "File Message".

Overrides:

getMessage in class BaseMessage

Returns:

The text.

Since:

3.0.119

getRequestId

public java.lang.String getRequestId()

Returns a file request ID.

Specified by:

getRequestId in class BaseMessage

Returns:

String ID.

getUrl

public java.lang.String getUrl()

Returns the file URL. If the file encryption feature is enabled, the returned url will contain encryption key as a parameter.

If you enabled the file encryption feature and want to cache the file with URL string as a key, it is recommended to use getPlainUrl() instead. This is because the URL returned by this method embeds SendBird.getEkey(), which changes at every login, leading to a frequent cache miss.

Returns:

The URL.

See Also:

getPlainUrl()

getPlainUrl

public java.lang.String getPlainUrl()

Returns the plain file URL, which does not contain SendBird.getEkey() as a parameter. If the file encryption feature is enabled, you must put SendBird.getEkey() to the request header with as the key. Otherwise, the server will refuse the connection.

Generally, it is recommended to use getUrl() to fetch resources, but if you want to cache the file with URL string as a key while enabled the file encryption feature, it is recommended to use this method instead. This is because the URL returned by this method does not embed SendBird.getEkey(), making it a less changing cache key.

Returns:

Plain file URL without a parameter.

Since:

3.0.140

See Also:

SendBird.getEkey(), getUrl()

getName

public java.lang.String getName()

Returns name of the file.

Returns:

The name.

getSize

public int getSize()

Returns size of the file.

Returns:

The size.

getType

public java.lang.String getType()

Returns the type of the file. MIME preferred.

Returns:

The type.

getThumbnails

public java.util.List<FileMessage.Thumbnail> getThumbnails()

Returns the thumbnail information of image file. To make thumbnail of image when you send it, please refer to BaseChannel.sendFileMessage(File, String, String, int, String, String, List, BaseChannel.SendFileMessageHandler).

Returns:

Thumbnail information.

Since:

3.0.14

getRequestState

@Deprecated
public FileMessage.RequestState getRequestState()

Deprecated. As of 3.0.120, replaced by BaseMessage.getSendingStatus().

Returns message request state.

Returns:

Request state (refer to FileMessage.RequestState).

Since:

3.0.99

getRequestedMentionUserIds

public java.util.List<java.lang.String> getRequestedMentionUserIds()

Returns requested mention user ids. If sending status is not SendingStatus#PENDING or SendingStatus#FAILED or SendingStatus#CANCELED, empty list will be returned.

Returns:

Requested mention user ids.

Since:

3.0.99

getMessageParams

public FileMessageParams getMessageParams()

returns FileMessageParams object that used for sending this message It's not null when sendingStatus is SendingStatus#PENDING or SendingStatus#FAILED or SendingStatus#CANCELED If else, it will return null

Returns:

return FileMessageParams object. If sending status is SendingStatus#SUCCEEDED, return null.

Since:

3.1.0

See Also:

BaseMessageParams, UserMessageParams, FileMessageParams, UserMessage.getMessageParams(), getMessageParams()

toString

public java.lang.String toString()

Overrides:

toString in class BaseMessage