v2::V2NIMSettingService类 参考

通知服务 更多...

#include <v2_nim_setting_service.hpp>

Public 成员函数
virtual bool	getConversationMuteStatus (nstd::string conversationId)=0
	获取会话消息免打扰状态
virtual void	setTeamMessageMuteMode (nstd::string teamId, V2NIMTeamType teamType, V2NIMTeamMessageMuteMode muteMode, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置群消息免打扰模式
virtual V2NIMTeamMessageMuteMode	getTeamMessageMuteMode (nstd::string teamId, V2NIMTeamType teamType)=0
	获取群消息免打扰模式
virtual void	setP2PMessageMuteMode (nstd::string accountId, V2NIMP2PMessageMuteMode muteMode, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置点对点消息免打扰模式
virtual V2NIMP2PMessageMuteMode	getP2PMessageMuteMode (nstd::string accountId)=0
	获取点对点消息免打扰模式
virtual void	getP2PMessageMuteList (V2NIMSuccessCallback< nstd::vector< nstd::string > > success, V2NIMFailureCallback failure)=0
	获取点对点消息免打扰列表
virtual void	setPushMobileOnDesktopOnline (bool need, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置当桌面端在线时, 移动端是否需要推送
virtual void	setDndConfig (V2NIMDndConfig config, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置免打扰与详情显示
virtual V2NIMDndConfig	getDndConfig ()=0
	读取免打扰与详情显示接口
virtual void	addSettingListener (V2NIMSettingListener listener)=0
	添加设置监听
virtual void	removeSettingListener (V2NIMSettingListener listener)=0
	移除设置监听

详细描述

通知服务

前置条件

调用 V2NIMClient::get() 拿到 client 实例 调用 client.getSettingService() 拿到 settingService 实例

示例代码

auto& client = V2NIMClient::get();
auto& settingService = client.getSettingService();

成员函数说明

addSettingListener()

virtual void v2::V2NIMSettingService::addSettingListener ( V2NIMSettingListener  listener )

pure virtual

添加设置监听

参数

listener

监听器

返回

void

示例代码

V2NIMTeamListener listener;
listener.onTeamMessageMuteModeChanged = [](nstd::string teamId, V2NIMTeamType teamType, V2NIMTeamMessageMuteMode muteMode) {
    // handle team message mute mode changed
};
listener.onP2PMessageMuteModeChanged = [](nstd::string accountId, V2NIMP2PMessageMuteMode muteMode) {
    // handle p2p message mute mode changed
};
settingService.addSettingListener(listener);

getConversationMuteStatus()

virtual bool v2::V2NIMSettingService::getConversationMuteStatus ( nstd::string  conversationId )

pure virtual

获取会话消息免打扰状态

参数

conversationId

会话 ID

返回

bool 会话消息免打扰状态

示例代码

auto mute = settingService.getConversationMuteStatus(conversationId);

getDndConfig()

virtual V2NIMDndConfig v2::V2NIMSettingService::getDndConfig ( )

pure virtual

读取免打扰与详情显示接口

返回

V2NIMDndConfig

示例代码

V2NIMDndConfig dndConfig = settingService.getDndConfig();

getP2PMessageMuteList()

virtual void v2::V2NIMSettingService::getP2PMessageMuteList ( V2NIMSuccessCallback< nstd::vector< nstd::string > >  success, V2NIMFailureCallback  failure  )

pure virtual

获取点对点消息免打扰列表

参数

success	成功回调
failure	失败回调

返回

void

示例代码

settingService.getP2PMessageMuteList(
    [](nstd::vector<nstd::string> muteList) {
        // get p2p mute list succeeded, handle mute list
    },
    [](V2NIMError error) {
        // get p2p mute list failed, handle error
    });

getP2PMessageMuteMode()

virtual V2NIMP2PMessageMuteMode v2::V2NIMSettingService::getP2PMessageMuteMode ( nstd::string  accountId )

pure virtual

获取点对点消息免打扰模式

参数

accountId

账号

返回

V2NIMP2PMessageMuteMode 点对点消息免打扰模式

示例代码

auto muteMode = settingService.getP2PMessageMuteMode("accountId");

getTeamMessageMuteMode()

virtual V2NIMTeamMessageMuteMode v2::V2NIMSettingService::getTeamMessageMuteMode ( nstd::string  teamId, V2NIMTeamType  teamType  )

pure virtual

获取群消息免打扰模式

参数

teamId	群组 ID
teamType	群组类型

返回

V2NIMTeamMessageMuteMode 群消息免打扰模式

示例代码

auto muteMode = settingService.getTeamMessageMuteMode("teamId", V2NIM_TEAM_TYPE_NORMAL);

removeSettingListener()

virtual void v2::V2NIMSettingService::removeSettingListener ( V2NIMSettingListener  listener )

pure virtual

移除设置监听

参数

listener

监听器

返回

void

示例代码

V2NIMTeamListener listener;
// ......
settingService.addSettingListener(listener);
// ......
settingService.removeSettingListener(listener);

setDndConfig()

virtual void v2::V2NIMSettingService::setDndConfig ( V2NIMDndConfig  config, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

设置免打扰与详情显示

返回

V2NIMDndConfig

示例代码

V2NIMDndConfig config;
settingService.setDndConfig(
    config,
    []() {
        // set dnd config succeeded
    },
    [](V2NIMError error) {
        // set dnd config failed, handle error
    });
);

setP2PMessageMuteMode()

virtual void v2::V2NIMSettingService::setP2PMessageMuteMode ( nstd::string  accountId, V2NIMP2PMessageMuteMode  muteMode, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

设置点对点消息免打扰模式

参数

accountId	账号
muteMode	免打扰模式
success	成功回调
failure	失败回调

返回

void

示例代码

settingService.setP2PMessageMuteMode(
    "accountId",
    V2NIM_P2P_MESSAGE_MUTE_MODE_ON,
    []() {
        // set p2p mute mode succeeded
    },
    [](V2NIMError error) {
        // set p2p mute mode failed, handle error
    });

setPushMobileOnDesktopOnline()

virtual void v2::V2NIMSettingService::setPushMobileOnDesktopOnline ( bool  need, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

设置当桌面端在线时, 移动端是否需要推送

参数

need	是否需要推送
success	成功回调
failure	失败回调

返回

void

示例代码

settingService.setPushMobileOnDesktopOnline(
    true,
    []() {
        // set push mobile on desktop online succeeded
    },
    [](V2NIMError error) {
        // set push mobile on desktop online failed, handle error
    });

setTeamMessageMuteMode()

virtual void v2::V2NIMSettingService::setTeamMessageMuteMode ( nstd::string  teamId, V2NIMTeamType  teamType, V2NIMTeamMessageMuteMode  muteMode, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

设置群消息免打扰模式

参数

teamId	群组 ID
teamType	群组类型
muteMode	免打扰模式
success	成功回调
failure	失败回调

返回

void

示例代码

settingService.setTeamMessageMuteMode(
    "teamId",
    V2NIM_TEAM_TYPE_NORMAL,
    V2NIM_TEAM_MESSAGE_MUTE_MODE_ON,
    []() {
        // set team mute mode succeeded
    },
    [](V2NIMError error) {
        // set team mute mode failed, handle error
    });

---

该类的文档由以下文件生成:

• D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/include/v2_nim_setting_service.hpp