跳至主要內容

消息服务 SDK 接入指南

消息服务 SDK 接入指南

1. 初始化Push SDK并连接到 Push Server

参考 Push SDK 初始化指南，初始化 Push SDK并连接到 Push Server。

2.集成示例

查看当前公共频道信息

该方法可获取当前所有公共频道以及对应在线人数信息.

订阅频道

对于公共频道，需预先在网页上或者通过API创建，无法订阅不存在的公共频道。

对于非公共频道，订阅不存在的频道时会先创建后订阅，订阅存在的则直接订阅。

频道名称规则: 只能包含英文字母、数字、点(.)、下划线(_)和连字符(-)，且首尾必须是字母和数字，长度1-100个字符。

var publicChannels = new List<string>() { "public-001", "public-002" };
var guildChannels = new List<string>() { "guild-001", "guild-002" };
try
{
    // 订阅一些公共频道
    PushSDK.Instance.MessageService.SubscribeChannels(publicChannels, true);
    // 订阅玩家加入的公会频道
    PushSDK.Instance.MessageService.SubscribeChannels(guildChannels, false);
}
catch(PushSDKClientException ex)
{
    Debug.LogErrorFormat("Failed to subscribe channels. client ex: {0}", ex);
    throw;
}

SDK初始化时，可在onConnected方法中接入ListPublicChannelInfoAsync和SubscribeChannels，示例如下：

取消订阅频道

var channels = new List<string> { "public-001", "guild-001"};
try
{
    PushSDK.Instance.MessageService.UnsubscribeChannels(channels);
}
catch(PushSDKClientException ex)
{
    Debug.LogErrorFormat("Failed to Unsubscribe channels. client ex: {0}", ex);
    throw;
}

查看已订阅频道

注意：已订阅信息是非持久化信息，玩家每次上线需重新订阅所有需要订阅的频道。

var channels = PushSDK.Instance.MessageService.GetSubscribedChannels();
Debug.Log($"channels: {JsonConvert.SerializeObject(channels)}");

发送频道消息

某个玩家对指定频道发送一个消息后，订阅该频道的所有在线玩家将实时收到该消息，且频道消息支持缓存，新上线的玩家订阅某个频道时，将能收到最近的5条频道信息。 （注意：频道消息缓存实效为1小时，若某个频道1小时内未收到任何新消息，该频道消息缓存将被清空，后面上线的玩家订阅该频道时无法收到该频道缓存信息）

try
{
    var message = "hello, push"; //消息内容
    var channelName = "world-0"; // 频道名称
    var noCache = false; // 控制该消息是否需要缓存，如果缓存，此后订阅该频道的人可收到此缓存消息，如果不缓存，则收不到
    PushSDK.Instance.MessageService.SendChannelMessage(channelName, System.Text.Encoding.UTF8.GetBytes(message), noCache);
}
catch(PushSDKClientException ex)
{
    Debug.LogErrorFormat("Failed to send message. client ex: {0}", ex);
    throw;
}

发送玩家消息

发送玩家消息即仅对指定玩家发送私人消息，仅指定玩家能收到该消息，当前仅支持对在线玩家发送消息，仅当对方玩家在线时方可收到消息，当前不在线后续上线亦无法收到之前的消息 (开启离线玩家消息功能情况除外)。

try
{
    var playerId = "<playerId>"; // 玩家唯一id, 即被发送玩家初始化PushSDK时传入的Id
    var data = "hello player";
    PushSDK.Instance.MessageService.SendPlayerMessage(playerId, System.Text.Encoding.UTF8.GetBytes(data));
}
catch(PushSDKClientException ex)
{
    Debug.LogErrorFormat("Failed to send player message. client ex: {0}", ex);
    throw;
}

离线玩家消息

注意：此功能需联系我们开通。

push 支持缓存玩家离线时私聊消息，针对某一个玩家发送过来的离线消息，限制为300条。 当玩家上线时，离线期间的私聊消息将一次性推送给玩家。

更多

更多SDK使用示例可参考 Push Demo

4. 附录

消息服务核心类&接口