Easemob Windows SDK
|
Public Types | |
enum | EMDownloadStatus { DOWNLOADING, SUCCESSED, FAILED, PENDING } |
![]() | |
enum | EMMessageBodyType { TEXT, IMAGE, VIDEO, LOCATION, VOICE, FILE, COMMAND } |
Public Member Functions | |
EMFileMessageBody (EMMessageBodyType=FILE) | |
File message body constructor. More... | |
EMFileMessageBody (const std::string &localPath, EMMessageBodyType=FILE) | |
File message body constructor. More... | |
virtual | ~EMFileMessageBody () |
Class destructor. More... | |
std::string | displayName () const |
Get display name of the attachment. More... | |
void | setDisplayName (const std::string &) |
Set display name of the attachment. More... | |
const std::string & | localPath () const |
Get local path of the attachment. More... | |
void | setLocalPath (const std::string &) |
Set local path of the attachment. More... | |
const std::string & | remotePath () const |
Get remote path of the attachment. More... | |
void | setRemotePath (const std::string &) |
Set remote path of the attachment. More... | |
const std::string & | secretKey () const |
Get secret key of the attachment, it's used to download attachment from server. More... | |
void | setSecretKey (const std::string &) |
Set secret key of the attachment. More... | |
int64_t | fileLength () const |
Get file length of the attachment. More... | |
void | setFileLength (int64_t) |
Set file length of the attachment. More... | |
EMDownloadStatus | downloadStatus () const |
Get file download status of the attachment. More... | |
void | setDownloadStatus (EMDownloadStatus) |
Set download status of the attachment. More... | |
![]() | |
EMMessageBody (EMMessageBodyType=TEXT) | |
Message body constructor. More... | |
virtual | ~EMMessageBody () |
Class destructor. More... | |
EMMessageBodyType | type () const |
Get message body type. More... | |
![]() | |
template<typename T > | |
T * | cast () |
Additional Inherited Members | |
![]() | |
EMMessageBodyPrivate * | mBodyPrivate |
EMMessageBodyType | mType |
enum easemob::EMFileMessageBody::EMDownloadStatus |
Download status of file attachment.
easemob::EMFileMessageBody::EMFileMessageBody | ( | EMMessageBodyType | = FILE | ) |
File message body constructor.
Attachment | file type. |
easemob::EMFileMessageBody::EMFileMessageBody | ( | const std::string & | localPath, |
EMMessageBodyType | = FILE |
||
) |
File message body constructor.
Attachment | local path. |
Attachment | type |
|
virtual |
Class destructor.
NA |
std::string easemob::EMFileMessageBody::displayName | ( | ) | const |
Get display name of the attachment.
NA |
EMDownloadStatus easemob::EMFileMessageBody::downloadStatus | ( | ) | const |
Get file download status of the attachment.
NA |
int64_t easemob::EMFileMessageBody::fileLength | ( | ) | const |
Get file length of the attachment.
NA |
const std::string& easemob::EMFileMessageBody::localPath | ( | ) | const |
Get local path of the attachment.
NA |
const std::string& easemob::EMFileMessageBody::remotePath | ( | ) | const |
Get remote path of the attachment.
NA |
const std::string& easemob::EMFileMessageBody::secretKey | ( | ) | const |
Get secret key of the attachment, it's used to download attachment from server.
NA |
void easemob::EMFileMessageBody::setDisplayName | ( | const std::string & | ) |
Set display name of the attachment.
The | display name. |
void easemob::EMFileMessageBody::setDownloadStatus | ( | EMDownloadStatus | ) |
Set download status of the attachment.
Note: Usually, user should NOT call this method directly.
The | download status. |
void easemob::EMFileMessageBody::setFileLength | ( | int64_t | ) |
Set file length of the attachment.
Note: It's usually not necessary to call this method, will calculate file length automatically when setting local path.
The | file length. |
void easemob::EMFileMessageBody::setLocalPath | ( | const std::string & | ) |
Set local path of the attachment.
Note: Received meesage should NOT change the local path.
The | local path. |
void easemob::EMFileMessageBody::setRemotePath | ( | const std::string & | ) |
Set remote path of the attachment.
Note: It's internal used, user should never need to call this method.
The | remote path. |
void easemob::EMFileMessageBody::setSecretKey | ( | const std::string & | ) |
Set secret key of the attachment.
Note: It's internal used, user should never need to call this method.
The | secret key. |