Easemob Windows SDK
Classes | Public Member Functions | List of all members
easemob::EMImageMessageBody Class Reference
Inheritance diagram for easemob::EMImageMessageBody:
Inheritance graph
Collaboration diagram for easemob::EMImageMessageBody:
Collaboration graph

Classes

struct  Size
 

Public Member Functions

 EMImageMessageBody ()
 Image message body constructor. More...
 
 EMImageMessageBody (const std::string &localPath, const std::string &thumbnailLocalPath)
 Image message body constructor. More...
 
virtual ~EMImageMessageBody ()
 Class destructor. More...
 
void setThumbnailDisplayName (const std::string &)
 Set display name of the thumbnail. More...
 
const std::string & thumbnailDisplayName () const
 Get display name of the thumbnail. More...
 
void setThumbnailLocalPath (const std::string &)
 Set local path of the thumbnail. More...
 
const std::string & thumbnailLocalPath () const
 Get local path of the thumbnail. More...
 
void setThumbnailRemotePath (const std::string &)
 Set remote path of the thumbnail. More...
 
const std::string & thumbnailRemotePath () const
 Get remote path of the thumbnail. More...
 
void setThumbnailSecretKey (const std::string &)
 Set secret key of the thumbnail. More...
 
const std::string & thumbnailSecretKey () const
 Get secret key of the thumbnail. More...
 
void setThumbnailSize (const Size &)
 Set size of the thumbnail. More...
 
const SizethumbnailSize () const
 Get size of the thumbnail. More...
 
void setThumbnailFileLength (int64_t)
 Set file length of the thumbnail. More...
 
int64_t thumbnailFileLength () const
 Get file length of the thumbnail. More...
 
void setThumbnailDownloadStatus (EMDownloadStatus)
 Set download status of the thumbnail. More...
 
EMDownloadStatus thumbnailDownloadStatus () const
 Get download status of the thumbnail. More...
 
void setSize (const Size &)
 Set size of the image. More...
 
const Sizesize () const
 Get size of the image. More...
 
- Public Member Functions inherited from easemob::EMFileMessageBody
 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...
 
- Public Member Functions inherited from easemob::EMMessageBody
 EMMessageBody (EMMessageBodyType=TEXT)
 Message body constructor. More...
 
virtual ~EMMessageBody ()
 Class destructor. More...
 
EMMessageBodyType type () const
 Get message body type. More...
 
- Public Member Functions inherited from easemob::EMBaseObject
template<typename T >
T * cast ()
 

Additional Inherited Members

- Public Types inherited from easemob::EMFileMessageBody
enum  EMDownloadStatus { DOWNLOADING, SUCCESSED, FAILED, PENDING }
 
- Public Types inherited from easemob::EMMessageBody
enum  EMMessageBodyType {
  TEXT, IMAGE, VIDEO, LOCATION,
  VOICE, FILE, COMMAND
}
 
- Protected Attributes inherited from easemob::EMMessageBody
EMMessageBodyPrivate * mBodyPrivate
 
EMMessageBodyType mType
 

Constructor & Destructor Documentation

§ EMImageMessageBody() [1/2]

easemob::EMImageMessageBody::EMImageMessageBody ( )

Image message body constructor.

Parameters
NA
Returns
NA

§ EMImageMessageBody() [2/2]

easemob::EMImageMessageBody::EMImageMessageBody ( const std::string &  localPath,
const std::string &  thumbnailLocalPath 
)

Image message body constructor.

Parameters
Imageattachment local path.
Imagethumbnail local path.
Returns
NA

§ ~EMImageMessageBody()

virtual easemob::EMImageMessageBody::~EMImageMessageBody ( )
virtual

Class destructor.

Parameters
NA
Returns
NA

Member Function Documentation

§ setSize()

void easemob::EMImageMessageBody::setSize ( const Size )

Set size of the image.

Parameters
Theimage's size.
Returns
NA

§ setThumbnailDisplayName()

void easemob::EMImageMessageBody::setThumbnailDisplayName ( const std::string &  )

Set display name of the thumbnail.

Parameters
Thedisplay name.
Returns
NA

§ setThumbnailDownloadStatus()

void easemob::EMImageMessageBody::setThumbnailDownloadStatus ( EMDownloadStatus  )

Set download status of the thumbnail.

Note: Usually, user should NOT call this method directly.

Parameters
Thedownload status.
Returns
NA

§ setThumbnailFileLength()

void easemob::EMImageMessageBody::setThumbnailFileLength ( int64_t  )

Set file length of the thumbnail.

Note: It's usually not necessary to call this method, will calculate file length automatically when setting local path.

Parameters
Thefile length.
Returns
NA

§ setThumbnailLocalPath()

void easemob::EMImageMessageBody::setThumbnailLocalPath ( const std::string &  )

Set local path of the thumbnail.

Parameters
Thelocal path.
Returns
NA

§ setThumbnailRemotePath()

void easemob::EMImageMessageBody::setThumbnailRemotePath ( const std::string &  )

Set remote path of the thumbnail.

Note: It's internal used, user should never need to call this method.

Parameters
Theremote path.
Returns
NA

§ setThumbnailSecretKey()

void easemob::EMImageMessageBody::setThumbnailSecretKey ( const std::string &  )

Set secret key of the thumbnail.

Note: It's internal used, user should never need to call this method.

Parameters
Thesecret key.
Returns
NA

§ setThumbnailSize()

void easemob::EMImageMessageBody::setThumbnailSize ( const Size )

Set size of the thumbnail.

Parameters
Thethumbnail size.
Returns
NA

§ size()

const Size& easemob::EMImageMessageBody::size ( ) const

Get size of the image.

Parameters
NA
Returns
The image size.

§ thumbnailDisplayName()

const std::string& easemob::EMImageMessageBody::thumbnailDisplayName ( ) const

Get display name of the thumbnail.

Parameters
NA
Returns
The display name.

§ thumbnailDownloadStatus()

EMDownloadStatus easemob::EMImageMessageBody::thumbnailDownloadStatus ( ) const

Get download status of the thumbnail.

Parameters
NA
Returns
The download status.

§ thumbnailFileLength()

int64_t easemob::EMImageMessageBody::thumbnailFileLength ( ) const

Get file length of the thumbnail.

Parameters
NA
Returns
The file length.

§ thumbnailLocalPath()

const std::string& easemob::EMImageMessageBody::thumbnailLocalPath ( ) const

Get local path of the thumbnail.

Parameters
NA
Returns
The local path.

§ thumbnailRemotePath()

const std::string& easemob::EMImageMessageBody::thumbnailRemotePath ( ) const

Get remote path of the thumbnail.

Parameters
NA
Returns
The remote path.

§ thumbnailSecretKey()

const std::string& easemob::EMImageMessageBody::thumbnailSecretKey ( ) const

Get secret key of the thumbnail.

Parameters
NA
Returns
The secret key.

§ thumbnailSize()

const Size& easemob::EMImageMessageBody::thumbnailSize ( ) const

Get size of the thumbnail.

Parameters
NA
Returns
The thumbnail size.

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