Chat SDK for Unity and Windows v1.2.1
Public Member Functions | Public Attributes | List of all members
AgoraChat.MessageBody.FileBody Class Reference
Inheritance diagram for AgoraChat.MessageBody.FileBody:
AgoraChat.IMessageBody AgoraChat.MessageBody.ImageBody AgoraChat.MessageBody.VideoBody AgoraChat.MessageBody.VoiceBody

Public Member Functions

 FileBody (string localPath, string displayName="", long fileSize=0)
 

Public Attributes

string LocalPath
 
string DisplayName
 
string Secret
 
string RemotePath
 
long FileSize
 
DownLoadStatus DownStatus = DownLoadStatus.PENDING
 
- Public Attributes inherited from AgoraChat.IMessageBody
MessageBodyType Type
 

Additional Inherited Members

- Properties inherited from AgoraChat.IMessageBody
long OperationTime [get, set]
 
string OperatorId [get, set]
 
long OperationCount [get, set]
 

Detailed Description

The file message body.

Constructor & Destructor Documentation

◆ FileBody()

AgoraChat.MessageBody.FileBody.FileBody ( string  localPath,
string  displayName = "",
long  fileSize = 0 
)

The file message body constructor.

Parameters
localPathThe local path of the file.
displayNameThe display name of the file.
fileSizeThe file size in bytes.

Member Data Documentation

◆ LocalPath

string AgoraChat.MessageBody.FileBody.LocalPath

The local path of the file.

◆ DisplayName

string AgoraChat.MessageBody.FileBody.DisplayName

The display name of the file.

◆ Secret

string AgoraChat.MessageBody.FileBody.Secret

The secret for downloading the file.

◆ RemotePath

string AgoraChat.MessageBody.FileBody.RemotePath

The URL where the file is located on the server.

◆ FileSize

long AgoraChat.MessageBody.FileBody.FileSize

The file size in bytes.

◆ DownStatus

DownLoadStatus AgoraChat.MessageBody.FileBody.DownStatus = DownLoadStatus.PENDING

The file download status.