floo::BMXMessage#

訊息

#include <bmx_message.h>

Inherits from BMXBaseObject

Public Types#

Public Functions#

Public Types Documentation#

enum DeliveryStatus#

訊息投遞狀態

enum MessageType#

訊息類型

enum ContentType#

訊息內容類型

enum DeliveryQos#

訊息投遞質量

Public Functions Documentation#

function ~BMXMessage#

virtual ~BMXMessage()

析構函數

Example:

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

function msgId#

int64_t msgId()

訊息唯一ID

Return: int64_t

Example:

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

function clientMsgId#

int64_t clientMsgId()

訊息客戶端ID,僅在訊息發送端存在

Return: int64_t

Example:

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

function fromId#

int64_t fromId()

訊息發送方ID

Return: int64_t

Example:

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

function toId#

int64_t toId()

訊息接收方ID

Return: int64_t

Example:

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

function type#

MessageType type()

訊息類型

Return: MessageType

Example:

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

function conversationId#

int64_t conversationId()

訊息所屬會話ID

Return: int64_t

Example:

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

function deliveryStatus#

DeliveryStatus deliveryStatus()

訊息投遞狀態

Return: DeliveryStatus

Example:

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

function setDeliveryStatus#

void setDeliveryStatus(
    DeliveryStatus 
)

設定訊息投遞狀態

Example:

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

function serverTimestamp#

int64_t serverTimestamp()

訊息時間戳（服務端收到時的時間）

Return: int64_t

Example:

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

function setServerTimestamp#

void setServerTimestamp(
    int64_t 
)

設定時間戳（服務端收到時的時間）

Example:

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

function clientTimestamp#

int64_t clientTimestamp()

本地時間戳（訊息建立或者收到時的本地時間）

Return: int64_t

Example:

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

function setClientTimestamp#

void setClientTimestamp(
    int64_t 
)

設定訊息本地時間戳

Example:

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

function isPlayed#

bool isPlayed()

語音或者視訊訊息是否播放過，僅對收到的音視訊訊息有效

Return: bool

Example:

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

function setIsPlayed#

void setIsPlayed(
    bool 
)

設定語音或者視訊訊息是否播放過，僅對收到的音視訊訊息有效

Example:

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

function isPlayAcked#

bool isPlayAcked()

對於發送方表示是否收到了已播放回執，對於接收方表示是否發送了已播放回執

Return: bool

Example:

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

function setIsPlayAcked#

void setIsPlayAcked(
    bool 
)

設定已播放回執

Example:

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

function isReceiveMsg#

bool isReceiveMsg()

是否接收的訊息

Return: bool

Example:

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

function setIsReceiveMsg#

void setIsReceiveMsg(
    bool 
)

設定是否接收的訊息

Example:

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

function isRead#

bool isRead()

訊息是否已讀標誌

Return: bool

Example:

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

function setIsRead#

void setIsRead(
    bool 
)

訊息是否已讀標誌

Example:

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

function isReadAcked#

bool isReadAcked()

對於發送方表示是否收到了已讀回執，對於接收方表示是否發送了已讀回執

Return: bool

Example:

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

function setIsReadAcked#

void setIsReadAcked(
    bool 
)

設定已讀回執

Example:

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

function isDeliveryAcked#

bool isDeliveryAcked()

對於發送方表示訊息是否已投遞到對方，對於接收方表示是否發送了訊息已到達回執

Return: bool

Example:

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

function setIsDeliveryAcked#

void setIsDeliveryAcked(
    bool 
)

設定投遞迴執

Example:

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

function content#

const std::string & content()

訊息文本內容

Return: std::string

Example:

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

function setContent#

void setContent(
    const std::string & content
)

訊息文本內容

Parameters:

• content 訊息文本內容

Example:

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

function contentType#

ContentType contentType()

訊息內容類型，如果帶附件就表示附件類型，不帶附件就是文本類型

Return: ContentType

Example:

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

function attachment#

BMXMessageAttachmentPtr attachment()

訊息附件，BMXMessage擁有附件的所有權，負責釋放

Return: BMXMessageAttachmentPtr

Example:

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

function config#

BMXMessageConfigPtr config()

訊息的配置信息

Return: JSON(std::string)

Example:

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

function setConfig#

void setConfig(
    BMXMessageConfigPtr 
)

設定訊息配置信息

Example:

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

function extension#

const JSON & extension()

訊息擴展信息

Return: JSON(std::string)

Example:

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

function setExtension#

void setExtension(
    const JSON & 
)

設定訊息擴展信息

Example:

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

function deliveryQos#

DeliveryQos deliveryQos()

訊息投遞QOS

Return: DeliveryQos

Example:

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

function setDeliveryQos#

void setDeliveryQos(
    DeliveryQos qos
)

設定訊息投遞QOS

Parameters:

• qos 訊息投遞QOS

Example:

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

function senderName#

const std::string & senderName()

訊息發送者的顯示名稱

Return: std::string

Example:

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

function setSenderName#

void setSenderName(
    const std::string & senderName
)

設定訊息的發送者顯示名稱

Parameters:

• senderName 訊息文本內容

Example:

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

function groupAckCount#

int groupAckCount()

群訊息已讀AckCount數目

Return: int

Example:

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

function setGroupAckCount#

void setGroupAckCount(
    int count
)

設定訊息已讀groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)

Parameters:

• count 設定群訊息已讀數目

Example:

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

function groupAckUnreadCount#

int groupAckUnreadCount()

群訊息未讀AckCount數目

Return: int

Example:

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

function setGroupAckUnreadCount#

void setGroupAckUnreadCount(
    int count
)

設定訊息未讀groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)

Parameters:

• count 設定群訊息未讀數目

Example:

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

function groupAckReadAll#

bool groupAckReadAll()

群訊息是否全部已讀

Return: bool

Example:

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

function groupPlayAckCount#

int groupPlayAckCount()

群訊息已播放AckCount數目（僅用於音訊/視訊附件訊息）

Return: int

Example:

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

function setGroupPlayAckCount#

void setGroupPlayAckCount(
    int count
)

設定訊息已播放groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)（僅用於音訊/視訊附件訊息）

Parameters:

• count 設定群訊息已讀數目

Example:

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

function groupPlayAckUnreadCount#

int groupPlayAckUnreadCount()

群訊息未播放AckCount數目（僅用於音訊/視訊附件訊息）

Return: int

Example:

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

function setGroupPlayAckUnreadCount#

void setGroupPlayAckUnreadCount(
    int count
)

設定訊息未播放groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)（僅用於音訊/視訊附件訊息）

Parameters:

• count 設定群訊息未播放數目

Example:

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

function groupPlayAckReadAll#

bool groupPlayAckReadAll()

群訊息是否全部已播放

Return: bool

Example:

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

function setPriority#

void setPriority(
    int priority
)

設定訊息的擴散優先級，預設為0。0表示擴散，數字越小擴散的越多。

Parameters:

• priority 設定群訊息未讀數目

取值範圍0-10。普通人在聊天室發送的訊息級別預設為5，可以丟棄。管理員預設為0不會丟棄。其它值可以根據業務自行設定。

Example:

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

function priority#

int priority()

訊息的擴散優先級

Return: int

Example:

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

function setPushMessageMode#

void setPushMessageMode(
    bool 
)

設定訊息是否為推播訊息。

Example:

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

function isPushMessage#

bool isPushMessage()

訊息是否是推播訊息

Return: bool

Example:

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

function createMessage#

static BMXMessagePtr createMessage(
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    const std::string & content
)

建立發送文本訊息

Parameters:

• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• content 訊息內容

Example:

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

function createMessage#

static BMXMessagePtr createMessage(
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    BMXMessageAttachmentPtr attachment
)

建立發送附件訊息

Parameters:

• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• attachment 附件

Example:

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

function createCommandMessage#

static BMXMessagePtr createCommandMessage(
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    const std::string & content
)

建立發送命令訊息(命令訊息通過content欄位或者extension欄位存放命令信息)

Parameters:

• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• content 訊息內容

Example:

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

function createMessage#

static BMXMessagePtr createMessage(
    int64_t msgId,
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    const std::string & content,
    int64_t serverTimestamp
)

建立收到的訊息

Parameters:

• msgId 訊息id
• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• content 訊息內容
• serverTimestamp 伺服器時間戳

Example:

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

function createMessage#

static BMXMessagePtr createMessage(
    int64_t msgId,
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    BMXMessageAttachmentPtr attachment,
    int64_t serverTimestamp
)

建立收到的訊息

Parameters:

• msgId 訊息id
• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• attachment 附件
• serverTimestamp 伺服器時間戳

Example:

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

function createCommandMessage#

static BMXMessagePtr createCommandMessage(
    int64_t msgId,
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId,
    const std::string & content,
    int64_t serverTimestamp
)

建立收到的命令訊息(命令訊息通過content欄位或者extension欄位存放命令信息)

Parameters:

• msgId 訊息id
• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id
• content 訊息內容
• serverTimestamp 伺服器時間戳

Example:

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

function createForwardMessage#

static BMXMessagePtr createForwardMessage(
    BMXMessagePtr msg,
    int64_t from,
    int64_t to,
    MessageType type,
    int64_t conversationId
)

建立轉發訊息

Parameters:

• msg 要轉發的訊息
• from 訊息發送者
• to 訊息接收者
• type 訊息類型
• conversationId 會話id

Example:

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

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