Sendbird Chat SDK for .NET  3.0.29
SendBird.FileMessage Class Reference
Inheritance diagram for SendBird.FileMessage:
SendBird.BaseMessage

Classes

class  ThumbnailSize
 

Properties

string? Url [get]
 
string PlainUrl [get]
 
string Name [get]
 
int Size [get]
 
string Type [get]
 
override string Message [get]
 
override string RequestId [get]
 
User Sender [get]
 
- Properties inherited from SendBird.BaseMessage
abstract string RequestId [get]
 
abstract string Message [get]
 
SendingStatus GetSendingStatus [get]
 
string UserId [get]
 
long MessageId [get]
 
long CreatedAt [get]
 
long UpdatedAt [get]
 
string ChannelUrl [get]
 
string Data [get]
 
string CustomType [get]
 
List< UserMentionedUsers [get]
 
List< string > MentionedUserIds [get]
 
long RootMessageId [get]
 
long ParentMessageId [get]
 
BaseMessageParams.MentionType GetMentionType [get]
 
bool IsOperatorMessage [get]
 
bool IsSilent [get]
 
bool ShouldForceUpdateLastMessage [get]
 

Additional Inherited Members

- Public Types inherited from SendBird.BaseMessage
enum  MentionType { USERS, CHANNEL }
 
- Public Member Functions inherited from SendBird.BaseMessage
Sender GetSender ()
 
override string ToString ()
 
void SetSendingStatus (SendingStatus sendingStatus)
 
bool IsOpenChannel ()
 
bool IsGroupChannel ()
 
virtual byte[] Serialize ()
 
- Static Public Member Functions inherited from SendBird.BaseMessage
static bool BelongsTo (BaseMessage message, string userId)
 
static bool EqualsIgnoreCase (string userId, string anotherString)
 
static bool BelongsTo (BaseMessage message, User user)
 
static string Base64Decode (string data)
 
static byte[] Base64Encode (string data)
 
static BaseMessage BuildFromSerializedData (byte[] data)
 

Detailed Description

Object representing a file.

Property Documentation

◆ Message

override string SendBird.FileMessage.Message
get

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

Returns
The text.
Since
3.0.15

◆ Name

string SendBird.FileMessage.Name
get

Returns name of the file.

Returns
The name.

◆ PlainUrl

string SendBird.FileMessage.PlainUrl
get

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 {@value StringSet::user_auth_key} 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.
See also
SendBird::getEkey()
#getUrl()
Since
3.0.18

◆ RequestId

override string SendBird.FileMessage.RequestId
get

Returns a file request ID.

Returns
string ID.

◆ Sender

User SendBird.FileMessage.Sender
get

Returns sender.

Returns
The sender.

◆ Size

int SendBird.FileMessage.Size
get

Returns size of the file.

Returns
The size.

◆ Type

string SendBird.FileMessage.Type
get

Returns the type of the file. MIME preferred.

Returns
The type.

◆ Url

string? SendBird.FileMessage.Url
get

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 PlainUrl() instead. This is because the URL returned by this method embeds SendBird#Ekey, which changes at every login, leading to a frequent cache miss.

Returns
The URL.
See also
#getPlainUrl()

The documentation for this class was generated from the following file: