开发指南
Combo SDK 聚合了 Android 与 iOS 系统分享及小红书、微信、微博、抖音媒体平台的分享方式,并通过统一的接口将各平台的差异性抹除,游戏客户端只需要对接 Combo SDK 中社交分享功能的 API 即可。
图片资源分享
支持平台
方法签名
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);
}
});
方法参数
Parameters | Required | Type | Description |
---|---|---|---|
opts | True | ImageShareOptions | 图片分享传入的参数集 |
callback | True | Action<Result<ShareResult>> | 分享完成后的回调方法 |
ImageShareOptions
Parameters | Required | Type | Description |
---|---|---|---|
ImageUrl | True | string | 分享的本地图片路径 |
Title | False | string | 分享的标题 |
Text | False | string | 分享的文本描述内容 |
Hashtag | False | string | 分享附加话题 |
Scene | False | ShareScene | 分享目标场景 |
Target | False | ShareTarget | 分享目标平台 |
提示
- 不同媒体平台对上述参数支持情况不同,如
Hashtag
仅抖音平台支持,详情请查看 分享规则说明。 ImageUrl
建议指向Application.temporaryCachePath
或Application.persistentDataPath
目录下的图片资源,否则可能无法正常读取资源。- 支持配置默认分享文案,若需配置默认分享文案,请联系世游运营人员,
Text
内容将覆盖配置的默认文案。
ShareResult
Properties | Supported Platforms | Type | Description |
---|---|---|---|
视频资源分享
支持平台
方法签名
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);
}
});
方法参数
Parameters | Required | Type | Description |
---|---|---|---|
opts | True | VideoShareOptions | 视频分享传入的参数集 |
callback | True | Action<Result<ShareResult>> | 分享完成后的回调方法 |
VideoShareOptions
Parameters | Required | Type | Description |
---|---|---|---|
VideoUrl | True | string | 分享的视频路径 |
Title | False | string | 分享的标题 |
Text | False | string | 分享的文本描述内容 |
VideoCoverUrl | False | string | 视频封面路径,微信视频封面缩略图大小不超过 32KB |
Hashtag | False | string | 分享附加话题 |
Scene | False | ShareScene | 分享目标场景 |
Target | False | ShareTarget | 分享目标平台 |
提示
- 不同媒体平台对上述参数支持情况不同,如
Hashtag
仅抖音平台支持,详情请查看 分享规则说明。 - 本地媒体资源(图片、视频)建议指向
Application.temporaryCachePath
或Application.persistentDataPath
目录下的媒体资源,否则可能无法正常读取。 - 支持配置默认分享文案,若需配置默认分享文案,请联系世游运营人员,
Text
属性内容将覆盖配置的默认文案。
ShareResult
Properties | Supported Platforms | Type | Description |
---|---|---|---|
链接资源分享
提示
仅系统分享支持分享网络链接。
支持平台
方法签名
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);
}
});
方法参数
Parameters | Required | Type | Description |
---|---|---|---|
opts | True | LinkShareOptions | 链接分享传入的参数集 |
callback | True | Action<Result<ShareResult>> | 分享完成后的回调方法 |
LinkShareOptions
Parameters | Required | Type | Description |
---|---|---|---|
LinkUrl | True | string | 分享的网络链接 |
Title | False | string | 分享的标题 |
Text | False | string | 分享的文本描述内容 |
LinkCoverUrl | False | string | 链接封面路径,本地图片资源 |
Target | False | ShareTarget | 分享目标平台 |
ShareResult
Properties | Supported Platforms | Type | Description |
---|---|---|---|
获取可用的分享方式
信息
- Combo SDK 各媒体平台分享功能是选接的,因此不同项目支持的分享目标平台会有所不同,默认支持系统分享。
- 建议使用此接口判断是否支持目标分享平台,当确认该平台可用后,再显示相关分享平台的按钮。
支持平台
方法签名
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 Key | Supported Platforms | Description |
---|---|---|
WEIXIN_SESSION | 微信会话 | |
WEIXIN_TIMELINE | 微信朋友圈 | |
WEIXIN_FAVORITE | 微信收藏 | |
DOUYIN_EDIT | 抖音编辑页 | |
DOUYIN_PUBLISH | 抖音发布页 | |
DOUYIN_CONTACTS | 抖音私信 |
ShareTarget
警告
在传入 ShareTarget 前,请先确认该平台分享功能是否可用,详情请参考 GetAvailableShareTargets 接口。
Enum Key | Supported Platforms | Description |
---|---|---|
SYSTEM | 系统分享 | |
TAPTAP | TapTap 分享 | |
AGORA | 小红书分享 | |
WEIXIN | 微信分享 | |
微博分享 | ||
DOUYIN | 抖音分享 |