FileMessageParams (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.BaseMessageParams
- - com.sendbird.android.FileMessageParams

```
public class FileMessageParams
extends BaseMessageParams
```
Represents a file message params. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)

Since:

3.0.52

Nested Class Summary
- Nested classes/interfaces inherited from class com.sendbird.android.BaseMessageParams
  BaseMessageParams.MentionType, BaseMessageParams.PushNotificationDeliveryOption

Constructor Summary

Constructors
Constructor and Description
`FileMessageParams()` FileMessageParams constructor.
`FileMessageParams(java.io.File file)` FileMessageParams constructor.
`FileMessageParams(java.lang.String fileUrl)` FileMessageParams constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.io.File`	`getFile()` returns file.
`java.lang.String`	`getFileName()` Returns file name.
`java.lang.Integer`	`getFileSize()` Returns file size.
`java.lang.String`	`getFileUrl()` returns file url.
`java.lang.String`	`getMimeType()` Returns mime type.
`java.util.List<FileMessage.ThumbnailSize>`	`getThumbnailSizes()` Returns thumbnail sizes.
`FileMessageParams`	`setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions)` set apple critical alert options for this instance.
`FileMessageParams`	`setCustomType(java.lang.String customType)` Sets custom type.
`FileMessageParams`	`setData(java.lang.String data)` Sets data.
`FileMessageParams`	`setFile(java.io.File file)` Sets file.
`FileMessageParams`	`setFileName(java.lang.String fileName)` Sets file name.
`FileMessageParams`	`setFileSize(int fileSize)` Sets the file size.
`FileMessageParams`	`setFileUrl(java.lang.String fileUrl)` Sets fileUrl.
`FileMessageParams`	`setMentionedUserIds(java.util.List<java.lang.String> mentionedUserIds)` Set mentioned users ids.
`FileMessageParams`	`setMentionedUsers(java.util.List<User> mentionedUsers)` Set mentioned users.
`FileMessageParams`	`setMentionType(BaseMessageParams.MentionType mentionType)` Sets mention type.
`FileMessageParams`	`setMetaArrayKeys(java.util.List<java.lang.String> metaArrayKeys)` Deprecated. As of 3.0.129, replaced by `setMetaArrays(List)`.
`FileMessageParams`	`setMetaArrays(java.util.List<MessageMetaArray> metaArrays)` Sets meta arrays.
`FileMessageParams`	`setMimeType(java.lang.String mimeType)` Sets mime type.
`FileMessageParams`	`setParentMessageId(long parentMessageId)` Sets the parent message's id to create a child message.
`FileMessageParams`	`setPushNotificationDeliveryOption(BaseMessageParams.PushNotificationDeliveryOption pushNotificationDeliveryOption)` Sets push notification delivery option.
`FileMessageParams`	`setReplyToChannel(boolean replyToChannel)` Set whether to send the thread message to the channel as well.
`FileMessageParams`	`setThumbnailSizes(java.util.List<FileMessage.ThumbnailSize> thumbnailSizes)` Sets thumbnailSizes.
`java.lang.String`	`toString()`

Methods inherited from class com.sendbird.android.BaseMessageParams
getAppleCriticalAlertOptions, getCustomType, getData, getMentionedUserIds, getMentionedUsers, getMentionType, getMetaArrays, getParentMessageId, getPushNotificationDeliveryOption, getReplyToChannel, getRootMessageId

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileMessageParams
```
public FileMessageParams()
```
    FileMessageParams constructor.
    
    Since:
    
    3.0.71
  - FileMessageParams
```
public FileMessageParams(java.lang.String fileUrl)
```
    FileMessageParams constructor.
    
    Parameters:
    
    fileUrl - fileUrl
    
    Since:
    
    3.0.52
  - FileMessageParams
```
public FileMessageParams(java.io.File file)
```
    FileMessageParams constructor.
    
    Parameters:
    
    file - file
    
    Since:
    
    3.0.52
- Method Detail
  - getFileUrl
```
public java.lang.String getFileUrl()
```
    returns file url. If it hasn't set before, it returns null If setFile was lastly called, it returns null
    
    Returns:
    
    file url. if url hasn't set before or the file was lastly set, it returns null
  - setFileUrl
```
public FileMessageParams setFileUrl(java.lang.String fileUrl)
```
    Sets fileUrl. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    fileUrl - fileUrl
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.71
  - getFile
```
public java.io.File getFile()
```
    returns file. If it hasn't set before, it returns null If setFileUrl was lastly called, it returns null
    
    Returns:
    
    file. if file hasn't set before or the file url was lastly set, it returns null
  - setFile
```
public FileMessageParams setFile(java.io.File file)
```
    Sets file. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    file - file
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.71
  - getFileName
```
public java.lang.String getFileName()
```
    Returns file name. If it hasn't set before, it returns null
    
    Returns:
    
    file name. If it hasn't set before, it returns null
    
    Since:
    
    3.1.0
  - setFileName
```
public FileMessageParams setFileName(java.lang.String fileName)
```
    Sets file name. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    fileName - fileName
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - getMimeType
```
public java.lang.String getMimeType()
```
    Returns mime type. If it hasn't set before, it returns null
    
    Returns:
    
    mime type. If it hasn't set before, it returns null
    
    Since:
    
    3.1.0
  - setMimeType
```
public FileMessageParams setMimeType(java.lang.String mimeType)
```
    Sets mime type. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    mimeType - mimeType
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - getFileSize
```
public java.lang.Integer getFileSize()
```
    Returns file size. If it hasn't set before, it returns null
    
    Returns:
    
    file size. If it hasn't set before, it returns null
    
    Since:
    
    3.1.0
  - setFileSize
```
public FileMessageParams setFileSize(int fileSize)
```
    Sets the file size. This value will only be used when sending a file message with a url. When sending a file message with local file, Sendbird calculates the file size on your behalf and this value will be ignored. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    fileSize - fileSize
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - getThumbnailSizes
```
public java.util.List<FileMessage.ThumbnailSize> getThumbnailSizes()
```
    Returns thumbnail sizes. If it hasn't set before, it returns null
    
    Returns:
    
    thumbnail sizes. If it hasn't set before, it returns null
    
    Since:
    
    3.1.0
  - setThumbnailSizes
```
public FileMessageParams setThumbnailSizes(java.util.List<FileMessage.ThumbnailSize> thumbnailSizes)
```
    Sets thumbnailSizes. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    thumbnailSizes - thumbnailSizes
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - setData
```
public FileMessageParams setData(java.lang.String data)
```
    Sets data. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    data - data
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - setCustomType
```
public FileMessageParams setCustomType(java.lang.String customType)
```
    Sets custom type. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    customType - custom type
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - setMentionType
```
public FileMessageParams setMentionType(BaseMessageParams.MentionType mentionType)
```
    Sets mention type. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    mentionType - mention type. Refer to BaseMessageParams.MentionType.
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.64
  - setMentionedUsers
```
public FileMessageParams setMentionedUsers(java.util.List<User> mentionedUsers)
```
    Set mentioned users. Setting this will overwrite values set by setMentionedUserIds(List). BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    mentionedUsers - mentionedUsers
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - setMentionedUserIds
```
public FileMessageParams setMentionedUserIds(java.util.List<java.lang.String> mentionedUserIds)
```
    Set mentioned users ids. Setting this will overwrite values set by setMentionedUsers(List). BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    mentionedUserIds - mentionedUserIds
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.52
  - setPushNotificationDeliveryOption
```
public FileMessageParams setPushNotificationDeliveryOption(BaseMessageParams.PushNotificationDeliveryOption pushNotificationDeliveryOption)
```
    Sets push notification delivery option. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    pushNotificationDeliveryOption - push notification delivery option
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.56
  - setMetaArrayKeys
```
@Deprecated
public FileMessageParams setMetaArrayKeys(java.util.List<java.lang.String> metaArrayKeys)
```
    Deprecated. As of 3.0.129, replaced by setMetaArrays(List).
    
    Sets meta array keys. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    metaArrayKeys - metaArrayKeys
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.76
  - setMetaArrays
```
public FileMessageParams setMetaArrays(java.util.List<MessageMetaArray> metaArrays)
```
    Sets meta arrays. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler) BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler)
    
    Parameters:
    
    metaArrays - metaArrays
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.129
  - setParentMessageId
```
public FileMessageParams setParentMessageId(long parentMessageId)
```
    Sets the parent message's id to create a child message. BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageHandler). BaseChannel.sendFileMessage(FileMessageParams, BaseChannel.SendFileMessageWithProgressHandler).
    
    Parameters:
    
    parentMessageId - parent BaseMessage's id if you want to make it a threaded message.
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.130
  - setAppleCriticalAlertOptions
```
public FileMessageParams setAppleCriticalAlertOptions(AppleCriticalAlertOptions appleCriticalAlertOptions)
```
    Description copied from class: BaseMessageParams
    
    set apple critical alert options for this instance.
    
    Overrides:
    
    setAppleCriticalAlertOptions in class BaseMessageParams
    
    Parameters:
    
    appleCriticalAlertOptions - an instance of AppleCriticalAlertOptions
    
    Returns:
    
    this instance
  - setReplyToChannel
```
public FileMessageParams setReplyToChannel(boolean replyToChannel)
```
    Set whether to send the thread message to the channel as well.
    
    Overrides:
    
    setReplyToChannel in class BaseMessageParams
    
    Parameters:
    
    replyToChannel - whether to send the thread message to the channel as well.
    
    Returns:
    
    FileMessageParams
    
    Since:
    
    3.0.173
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BaseMessageParams

Class FileMessageParams

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.sendbird.android.BaseMessageParams

Methods inherited from class java.lang.Object

Constructor Detail

FileMessageParams

FileMessageParams

FileMessageParams

Method Detail

getFileUrl

setFileUrl

getFile

setFile

getFileName

setFileName

getMimeType

setMimeType

getFileSize

setFileSize

getThumbnailSizes

setThumbnailSizes

setData

setCustomType

setMentionType

setMentionedUsers

setMentionedUserIds

setPushNotificationDeliveryOption

setMetaArrayKeys

setMetaArrays

setParentMessageId

setAppleCriticalAlertOptions

setReplyToChannel

toString