agora_rtm.FileMessage Class Reference

Inherits agora_rtm.IMessage.

Public Member Functions
	FileMessage (IntPtr MessagePtr)
	FileMessage (IntPtr MessagePtr, MESSAGE_FLAG MessageFlag)
	FileMessage (FileMessage fileMessage, MESSAGE_FLAG MessageFlag)
Int64	GetSize ()
string	GetMediaId ()
void	SetThumbnail (byte[] thumbnail)
byte[]	GetThumbnailData ()
void	SetFileName (string fileName)
string	GetFileName ()
Public Member Functions inherited from agora_rtm.IMessage
Int64	GetMessageId ()
MESSAGE_TYPE	GetMessageType ()
void	SetText (string text)
string	GetText ()
byte[]	GetRawMessageData ()
int	GetRawMessageLength ()
Int64	GetServerReceiveTs ()
bool	IsOfflineMessage ()
IntPtr	GetPtr ()
void	SetMessagePtr (IntPtr messagePtr)

Additional Inherited Members
Public Attributes inherited from agora_rtm.IMessage
int	_Length = 0
Protected Member Functions inherited from agora_rtm.IMessage
void	Release ()
Protected Attributes inherited from agora_rtm.IMessage
MESSAGE_FLAG	_MessageFlag = MESSAGE_FLAG.RECEIVE
IntPtr	_MessagePtr = IntPtr.Zero
Int64	_MessageId = 0
MESSAGE_TYPE	_MessageType = MESSAGE_TYPE.MESSAGE_TYPE_UNDEFINED
string	_MessageText = ""
bool	_IsOfflineMessage = false
Int64	_Ts = 0
byte[]	_RawMessageData = null

Constructor & Destructor Documentation

FileMessage() [1/3]

agora_rtm.FileMessage.FileMessage ( IntPtr  MessagePtr )

inline

FileMessage() [2/3]

agora_rtm.FileMessage.FileMessage ( IntPtr  MessagePtr, MESSAGE_FLAG  MessageFlag  )

inline

FileMessage() [3/3]

agora_rtm.FileMessage.FileMessage ( FileMessage  fileMessage, MESSAGE_FLAG  MessageFlag  )

inline

Member Function Documentation

GetFileName()

string agora_rtm.FileMessage.GetFileName ( )

inline

Gets the name of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Returns

The filename of the uploaded file.

GetMediaId()

string agora_rtm.FileMessage.GetMediaId ( )

inline

Gets the media ID of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Note

• The media ID is automatically populated once the file is uploaded to the file server.
• The media ID is valid for 7 days because the file server keeps all uploaded files for 7 days only.

Returns

The media ID of the uploaded file.

GetSize()

Int64 agora_rtm.FileMessage.GetSize ( )

inline

Gets the size of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Returns

The size of the uploaded file in bytes.

GetThumbnailData()

byte [] agora_rtm.FileMessage.GetThumbnailData ( )

inline

Gets the thumbnail of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Returns

The thumbnail of the uploaded file.

SetFileName()

void agora_rtm.FileMessage.SetFileName ( string  fileName )

inline

Sets the name of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Parameters

fileName

The name of the uploaded file. The total size of thumbnail and fileName must not exceed 32 KB.

SetThumbnail()

void agora_rtm.FileMessage.SetThumbnail ( byte[]  thumbnail )

inline

Sets the thumbnail of the uploaded file.

Deprecated:

This method is deprecated. Agora recommends that you do not use it.

Parameters

thumbnail

The thumbnail of the uploaded file. Must be binary data. The total size of thumbnail and fileName must not exceed 32 KB.

---

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

• FileMessage.cs