跳到主要内容

开发指南

Combo SDK 聚合了 Android 与 iOS 系统分享及小红书、微信、微博、抖音媒体平台的分享方式,并通过统一的接口将各平台的差异性抹除,游戏客户端只需要对接 Combo SDK 中社交分享功能的 API 即可。

图片资源分享

支持平台

Android iOS

方法签名

public static void Share(ImageShareOptions opts, Action<Result<ShareResult>> callback);

代码示例

Show Code
// 小红书图片分享
var opts = new ImageShareOptions
{
Title = "Share Title",
Text = "Share Text",
ImageUrl = Path.Combine(Application.temporaryCachePath, "sharePicture.png"),
Target = ShareTarget.AGORA
};

ComboSDK.Share(opts, r =>
{
if (r.IsSuccess)
{
var result = r.Data;
//TODO: 分享成功处理
}
else
{
var error = r.Error;
Debug.LogError("分享失败:" + error.DetailMessage);
}
});

方法参数

ParametersRequiredTypeDescription
optsTrueImageShareOptions图片分享传入的参数集
callbackTrueAction<Result<ShareResult>>分享完成后的回调方法

ImageShareOptions

ParametersRequiredTypeDescription
ImageUrlTruestring分享的本地图片路径
TitleFalsestring分享的标题
TextFalsestring分享的文本描述内容
HashtagFalsestring分享附加话题
SceneFalseShareScene分享目标场景
TargetFalseShareTarget分享目标平台
提示
  • 不同媒体平台对上述参数支持情况不同,如 Hashtag 仅抖音平台支持,详情请查看 分享规则说明
  • ImageUrl 建议指向 Application.temporaryCachePathApplication.persistentDataPath 目录下的图片资源,否则可能无法正常读取资源。
  • 支持配置默认分享文案,若需配置默认分享文案,请联系世游运营人员,Text 内容将覆盖配置的默认文案。

ShareResult

PropertiesSupported PlatformsTypeDescription

视频资源分享

支持平台

Android iOS

方法签名

public static void Share(VideoShareOptions opts, Action<Result<ShareResult>> callback);

代码示例

Show Code
// 抖音视频分享
var opts = new VideoShareOptions
{
Title = "Share Title",
VideoUrl = Path.Combine(Application.temporaryCachePath, "shareVideo.mp4"),
Hashtag = "The Hashtag",
Target = ShareTarget.DOUYIN,
Scene = ShareScene.DOUYIN_PUBLISH
};

ComboSDK.Share(opts, r =>
{
if (r.IsSuccess)
{
var result = r.Data;
//TODO: 分享成功处理
}
else
{
var error = r.Error;
Debug.LogError("分享失败:" + error.DetailMessage);
}
});

方法参数

ParametersRequiredTypeDescription
optsTrueVideoShareOptions视频分享传入的参数集
callbackTrueAction<Result<ShareResult>>分享完成后的回调方法

VideoShareOptions

ParametersRequiredTypeDescription
VideoUrlTruestring分享的视频路径
TitleFalsestring分享的标题
TextFalsestring分享的文本描述内容
VideoCoverUrlFalsestring视频封面路径,微信视频封面缩略图大小不超过 32KB
HashtagFalsestring分享附加话题
SceneFalseShareScene分享目标场景
TargetFalseShareTarget分享目标平台
提示
  • 不同媒体平台对上述参数支持情况不同,如 Hashtag 仅抖音平台支持,详情请查看 分享规则说明
  • 本地媒体资源(图片、视频)建议指向 Application.temporaryCachePathApplication.persistentDataPath 目录下的媒体资源,否则可能无法正常读取。
  • 支持配置默认分享文案,若需配置默认分享文案,请联系世游运营人员,Text 属性内容将覆盖配置的默认文案。
  • iOS 分享视频资源至 QQ 平台时,必须传入 Title 字段。

ShareResult

PropertiesSupported PlatformsTypeDescription
提示

系统分享、微信及 QQ 支持分享网络链接。

支持平台

Android iOS

方法签名

public static void Share(LinkShareOptions opts, Action<Result<ShareResult>> callback);

代码示例

Show Code
// 系统链接分享
var opts = new LinkShareOptions
{
Title = "Share Title",
Text = "Share Text",
LinkUrl = "https://docs.seayoo.com/",
LinkCoverUrl = Path.Combine(Application.temporaryCachePath, "cover.png"),
Target = ShareTarget.SYSTEM
};

ComboSDK.Share(opts, r =>
{
if (r.IsSuccess)
{
var result = r.Data;
//TODO: 分享成功处理
}
else
{
var error = r.Error;
Debug.LogError("分享失败:" + error.DetailMessage);
}
});

方法参数

ParametersRequiredTypeDescription
optsTrueLinkShareOptions链接分享传入的参数集
callbackTrueAction<Result<ShareResult>>分享完成后的回调方法
ParametersRequiredTypeDescription
LinkUrlTruestring分享的网络链接
TitleFalsestring分享的标题
TextFalsestring分享的文本描述内容
LinkCoverUrlFalsestring链接封面路径,本地图片资源
TargetFalseShareTarget分享目标平台
PropertiesSupported PlatformsTypeDescription

获取可用的分享方式

信息
  • Combo SDK 各媒体平台分享功能是选接的,因此不同项目支持的分享目标平台会有所不同,默认支持系统分享。
  • 建议使用此接口判断是否支持目标分享平台,当确认该平台可用后,再显示相关分享平台的按钮。

支持平台

Android iOS

方法签名

public static ShareTarget[] GetAvailableShareTargets();

代码示例

Show Code
using System.Linq;

var availableShares = ComboSDK.GetAvailableShareTargets();
if (availableShares.Contains(ShareTarget.TAPTAP))
{
//TODO: 显示 TapTap 分享按钮 UI
}
if (availableShares.Contains(ShareTarget.AGORA))
{
//TODO: 显示小红书分享按钮 UI
}
if (availableShares.Contains(ShareTarget.WEIXIN))
{
//TODO: 显示微信会话、朋友圈及收藏分享按钮 UI
}
if (availableShares.Contains(ShareTarget.WEIBO))
{
//TODO: 显示微博分享按钮 UI
}
if (availableShares.Contains(ShareTarget.DOUYIN))
{
//TODO: 显示抖音编辑页、发布页及私信分享按钮 UI(私信分享不支持视频)
}

ShareScene

Enum KeySupported PlatformsDescription
WEIXIN_SESSIONAndroid iOS微信会话
WEIXIN_TIMELINEAndroid iOS微信朋友圈
WEIXIN_FAVORITEAndroid iOS微信收藏
DOUYIN_EDITAndroid iOS抖音编辑页
DOUYIN_PUBLISHAndroid iOS抖音发布页
DOUYIN_CONTACTSAndroid iOS抖音私信
QQAndroid iOSQQ 好友
QZONEAndroid iOSQQ 空间

ShareTarget

警告

在传入 ShareTarget 前,请先确认该平台分享功能是否可用,详情请参考 GetAvailableShareTargets 接口。

Enum KeySupported PlatformsDescription
SYSTEMAndroid iOS系统分享
TAPTAPAndroidTapTap 分享
AGORAAndroid iOS小红书分享
WEIXINAndroid iOS微信分享
WEIBOAndroid iOS微博分享
DOUYINAndroid iOS抖音分享
QQAndroid iOSQQ 分享

Error

CodeSupported PlatformsDescription
INVALID_ARGUMENTSAndroid iOS无效的参数
USER_CANCELLEDAndroid iOS用户主动取消操作
THIRD_PARTY_ERRORAndroid iOS第三方 SDK 错误
UNKNOWN_ERRORAndroid iOS未知错误