floo::BMXLocationAttachment#

Location message attachment

#include <bmx_location_attachment.h>

Inherits from floo::BMXMessageAttachment, BMXBaseObject

Public Functions#

	Name
	BMXLocationAttachment(double latitude, double longitude, const std::string & address) Constructor
virtual	~BMXLocationAttachment() Destructor
virtual Type	type() const Return the type of location attachment
virtual BMXMessageAttachmentPtr	clone() const Cloning function
double	latitude() const Latitude
double	longitude() const Longitude
const std::string &	address() const Address

	Name
class	Encoder< BMXLocationAttachment >
class	Decoder< BMXLocationAttachment >

Public Types inherited from floo::BMXMessageAttachment

	Name
enum class	Type { Image, Voice, Video, File, Location, Command, Forward} Attachment type
enum class	DownloadStatus { Downloaing, Successed, Failed, NotStart, Canceled} Attachment download state

Public Functions inherited from floo::BMXMessageAttachment

	Name
	BMXMessageAttachment() Constructor
virtual	~BMXMessageAttachment() Destructor

BMXLocationAttachment(
    double latitude,
    double longitude,
    const std::string & address
)

Constructor

Parameters:

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="BMXLocationAttachment" %}{% endlanying_code_snippet %}

inline virtual ~BMXLocationAttachment()

Destructor

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="~BMXLocationAttachment" %}{% endlanying_code_snippet %}

inline virtual Type type() const

Return the type of location attachment

Return: Type

Reimplements: floo::BMXMessageAttachment::type

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="type" %}{% endlanying_code_snippet %}

virtual BMXMessageAttachmentPtr clone() const

Cloning function

Return: BMXMessageAttachmentPtr

Reimplements: floo::BMXMessageAttachment::clone

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="clone" %}{% endlanying_code_snippet %}

double latitude() const

Latitude

Return: double

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="latitude" %}{% endlanying_code_snippet %}

double longitude() const

Longitude

Return: double

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="longitude" %}{% endlanying_code_snippet %}

const std::string & address() const

Address

Return: std::string

friend class Encoder< BMXLocationAttachment >(
    Encoder< BMXLocationAttachment > 
);

friend class Decoder< BMXLocationAttachment >(
    Decoder< BMXLocationAttachment > 
);

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXLocationAttachment",function="address" %}{% endlanying_code_snippet %}

Updated on 2022-01-26 at 17:20:40 +0800