抖音云C#接口文档

/// <summary>
/// 获取已登录用户的基本信息或特殊信息
/// 若匿名登录后 userinfo里面字段全部为默认值
/// 登录了宿主后可以获取账号数据，下次不用login GetScUserInfo也可以返回正确数据
/// 新增 withCredentials 字段，如果为true  这样就会返回ScUserInfo 中 cloudId 就会被赋值，可以用于后续的抖音云的接口调用
/// </summary>
/// <param name="withCredentials">是否获取加密信息以及 CloudId</param>
/// <param name="successCallback">验证有效的回调</param>
/// <param name="failedCallback">验证无效或者验证失败的回调</param>
/// 
[StarkVersion(MinSCAndroidVersion = "5.45.0")]
public abstract void GetScUserInfo(Boolean withCredentials, OnGetScUserInfoSuccessCallback successCallback,
    OnGetScUserInfoFailedCallback failedCallback);

/// <summary>
///
/// 请求抖音云服务端接口
/// </summary>
/// <param name="eveId">抖音云平台环境id</param>
/// <param name="serviceId">抖音云平台服务id</param>
/// <param name="path">请求path</param>
/// <param name="options">请求参数</param>
/// <param name="success">成功回调</param>
/// <param name="fail">失败回调</param>

[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public abstract void CallContainer(string eveId, string serviceId, string path, Options options,
    Action<Response> success, Action<ErrorResponse> fail);

/// <summary>
/// 抖音云文件信息
/// </summary>
public class FileInfo
{
    public int Status;
    public string FileName;
    public string URL;
    public int MaxAge;
    public string Message;
    public string RawJsonString;
}

/// <summary>
/// 抖音云操作文件结果
/// </summary>
public class FileResponse
{
    public int StatusCode;
    public string ErrMsg;
    
}




/// <summary>
/// 获取抖音云文件 临时访问地址
/// </summary>
/// <param name="eveId">抖音云平台环境id</param>
/// <param name="cloudPaths">云文件path</param>
/// <param name="maxAge">最大有效期</param>
/// <param name="success">成功回调</param>
/// <param name="fail">失败回调</param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public abstract void GetTempFileUrl(string eveId, List<String> cloudPaths, int maxAge,
    Action<FileResponse> success, Action<ErrorResponse> fail);

/// <summary>
/// 抖音云文件删除
/// </summary>
/// <param name="eveId">抖音云平台环境id</param>
/// <param name="cloudPaths">云文件path</param>
/// <param name="success">成功回调</param>
/// <param name="fail">失败回调</param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public abstract void DeleteFile(string eveId, List<string> cloudPaths, Action<FileResponse> success,
    Action<FileResponse> fail);

/// <summary>
/// 上传抖音云文件结果
/// </summary>
public class UploadResponse
{
    public int TaskId;
    public int StatusCode;
    public string ErrMsg;
}

/// <summary>
/// 上传\下载抖音云文件 进度回调
/// </summary>
public class DownloadUploadProgressData
{
    public float Progress;
    public long TotalBytesSent;
    public long TotalBytesExpectedToSend;
}


/// <summary>
/// 抖音云文件上传
/// </summary>
/// <param name="eveId">抖音云平台环境id</param>
/// <param name="cloudPath">云文件path</param>
/// <param name="filePath"> 需要传递绝对路径</param> 
/// <param name="progress"> 上传进度回调</param>
/// <param name="success"> 上传成功毁掉</param>
/// <param name="fail"> 上传失败回调</param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public abstract void UploadFile(string eveId, string cloudPath, string filePath,
    Action<DownloadUploadProgressData> progress, Action<UploadResponse> success, Action<UploadResponse> fail);

/// <summary>
/// 下载抖音云文件结果
/// </summary>
public class DownloadResponse
{
    public int TaskId;
    public string State;
    public string FilePath;
    public int StatusCode;
    public string ErrMsg;
}


/// <summary>
/// 下载抖音云文件 
/// </summary>
/// <param name="eveId">抖音云平台环境id</param>
/// <param name="cloudPath">云文件path</param>
/// <param name="filePath">需要传递绝对路径</param>
/// <param name="progress">下载进度回调</param>
/// <param name="success">下载成功毁掉</param>
/// <param name="fail">下载成功毁掉</param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public abstract void DownloadFile(string eveId, string cloudPath, string filePath,
    Action<DownloadUploadProgressData> progress, Action<DownloadResponse> success,
    Action<DownloadResponse> fail);

/// <summary>
/// 创建 DBCollection 对象
/// </summary>
/// <param name="evnId">抖音云环境 ID</param>
/// <param name="name">集合名称</param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCollection GenDBCollection(string evnId, string name);

/// <summary>
/// 返回一个 ServerDate Json 对象, 用于表示服务端时间, 可以用于插入数据或者 查询的条件判断
/// </summary>
/// <param name="offsetTimeMil"></param>
/// <returns></returns>
public static JsonData GenServerDateJson(int offsetTimeMil)

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("create_time").Lt(CloudDB.GenServerDateJson(1000))

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("create_time").Gt(CloudDB.GenServerDateJson(-60 * 1000 * 60 * 24))

/// <summary>
/// 基于 docid 获取单个文档
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBDocument Doc(string id);

/// <summary>
/// 添加数据, 当前进支持单个添加
/// </summary>
/// <param name="dataMap"></param>
/// <param name="success"></param>
/// <param name="fail"></param>
/// 
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Add(JsonData dataMap, Action<StarkDouyinCloud.DBResponse> success,
    Action<StarkDouyinCloud.DBResponse> fail);

JsonData jsonData = new JsonData();
jsonData["string"] = "hello ";
StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME).Add(
    jsonData,
    response =>
    {
        // TODO check add 数量
        PrintText(
            $"TestDBAdd  RawCloudDb response.StatusCode:{response.StatusCode},response.Data:{response.Data.ToJson()}");
    },
    response =>
    {
        PrintText(
            $"TestDBAdd RawCloudDb response.StatusCode:{response.StatusCode},response.ErrMsg:{response.ErrMsg}");
    });

/// <summary>
///
/// where 条件查询, 录入 a=1,  a.b=1 
/// </summary>
/// <param name="query"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery where(Dictionary<string, object> query);

/// <summary>
/// 多种条件同时查询, 具体支持请看 CloudDBCommand
/// </summary>
/// <param name="cmd"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery AddWhereCmd(CloudDBCommand cmd);

/// <summary>
/// 设置查询结果返回的字段,  a=true  a.b=true
/// </summary>
/// <param name="field"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery Field(Dictionary<string, bool> field);

/// <summary>
/// 设置查询数据量限制
/// </summary>
/// <param name="limitNum"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery Limit(int limitNum);

/// <summary>
/// 设置查询跳过的数量
/// </summary>
/// <param name="skipCount"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery Skip(int skipCount);

/// <summary>
/// 设置查询的排序方式
/// </summary>
/// <param name="field"></param>
/// <param name="orderDirection"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBQuery OrderBy(string field, OrderDirection orderDirection);

/// <summary>
/// 获取查询结果
/// </summary>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Get(Action<StarkDouyinCloud.DBResponse> success, Action<StarkDouyinCloud.DBResponse> fail);

/// <summary>
/// 获取查询结果 使用 count 语句
/// </summary>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Count(Action<StarkDouyinCloud.DBResponse> success, Action<StarkDouyinCloud.DBResponse> fail);

/// <summary>
///
/// 基于设置的条件 更新数据
/// </summary>
/// <param name="dataMap"></param>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Update(JsonData dataMap, Action<StarkDouyinCloud.DBResponse> success,
    Action<StarkDouyinCloud.DBResponse> fail);

/// <summary>
/// 基于设置的条件 删除数据
/// </summary>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Remove(Action<StarkDouyinCloud.DBResponse> success,
    Action<StarkDouyinCloud.DBResponse> fail);

Dictionary<string, object> query = new Dictionary<string, object>();
query[queryKey] = exceptValue;
CloudDBCollection cloudDBCollection = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
    .GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME);

if (skip > 0)
{
    cloudDBCollection.Skip(skip);
}

cloudDBCollection.Where(query);

if (limit > 0)
{
    cloudDBCollection.Limit(limit);
}

if (isCheckOrder)
{
    cloudDBCollection.OrderBy(orderKey, orderDirection);
}

if (field != null)
{
    cloudDBCollection.Field(field);
}
// 上述条件设置完成后， 调用具体的查询 、更新方法
cloudDBCollection.Get(
     response =>
    {
        // TODO check add 数量
        PrintText(
            $"TestDBAdd  RawCloudDb response.StatusCode:{response.StatusCode},response.Data:{response.Data.ToJson()}");
    },
    response =>
    {
        PrintText(
            $"TestDBAdd RawCloudDb response.StatusCode:{response.StatusCode},response.ErrMsg:{response.ErrMsg}");
    }）

/// <summary>
/// 获取抖音云数据单个文档数据
/// </summary>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Get(Action<StarkDouyinCloud.DBResponse> success, Action<StarkDouyinCloud.DBResponse> fail);

// 调用示例：
StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME)
    .Doc(DyCloudTestDocId).Get(
        succResponse =>
        {


        },
        failResponse =>
        {

        });

/// <summary>
///
/// 更新单个云文档数据
/// </summary>
/// <param name="dataMap"></param>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Update(JsonData dataMap, Action<StarkDouyinCloud.DBResponse> success,
    Action<StarkDouyinCloud.DBResponse> fail);

JsonData updateData = GetTestDocJson(2);
updateData["update_new_field"] = "hello value by TestDbDocUpdateJson";
StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME)
    .Doc(DyCloudTestDocId).Update(updateData,
        response =>
        {
            PrintText(
                $"TestDbDocUpdate  RawCloudDb response.StatusCode:{response.StatusCode},response.Data:{response.Data.ToJson()}");
        },
        response =>
        {
            PrintText(
                $"TestDbDocUpdate failed response.StatusCode:{response.StatusCode},response.ErrMsg:{response.ErrMsg}");
        });

/// <summary>
/// 设置单个云文档数据, 仅会更新已有字段
/// </summary>
/// <param name="dataMap"></param>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Set(JsonData dataMap, Action<StarkDouyinCloud.DBResponse> success,
    Action<StarkDouyinCloud.DBResponse> fail);

JsonData setData = GetTestDocJson(1);
setData["set_new_field"] = "hello value by TestDbDocSetJson";
StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME)
    .Doc(DyCloudTestDocId).Set(setData,
        response =>
        {
            PrintText(
                $"TestDbDocSet  RawCloudDb response.StatusCode:{response.StatusCode} response.ErrMsg:{response.ErrMsg} ,response.Data:{response.Data.ToJson()}");
        },
        response =>
        {
            PrintText(
                $"TestDbDocSet failed response.StatusCode:{response.StatusCode} response.ErrMsg:{response.ErrMsg}");
        });

/// <summary>
///
/// 删除单个云文档数据
/// </summary>
/// <param name="success"></param>
/// <param name="fail"></param>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public void Remove(Action<StarkDouyinCloud.DBResponse> success, Action<StarkDouyinCloud.DBResponse> fail);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME)
    .Doc(DyCloudTestDocId).Remove(
        response =>
        {
            PrintText(
                $"TestDbDocRemove  RawCloudDb response.StatusCode:{response.StatusCode},response.Data:{response.Data.ToJson()}");
        },
        response =>
        {
            PrintText(
                $"TestDbDocRemove failed response.StatusCode:{response.StatusCode},response.ErrMsg:{response.ErrMsg}");
        });

/// <summary>
///
/// 基于字段名 创建 DbCmd 对象， 后续的cmd 都是基于此字段的操作
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand GenDbCmd(string name);

// 创建查询条件
CloudDBCommand cmd1 = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Lt(3))


CloudDBCollection cloudDBCollection = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
    .GenDBCollection(DY_CLOUD_EVN_ID, DY_CLOYD_DB_NAME);
    
// DBCollection 加入查询调整， 可以同时添加多个查询条
cloudDBCollection.AddWhereCmd(cmd1);
cloudDBCollection.AddWhereCmd(cmd2);
cloudDBCollection.AddWhereCmd(cmd3);

/// <summary>
/// 数据库操作符 = 
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Eq(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Eq(3))

/// <summary>
/// 数据库操作符 !=
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Neq(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Neq(3))

/// <summary>
/// 数据库操作符 <
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Lt(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Lt(3))

/// <summary>
/// 数据库操作符 <=
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Lte(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Lte(3))

/// <summary>
/// 数据库操作符 >
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Gt(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Gt(3))

/// <summary>
/// 数据库操作符 >= 
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Gte(object para);

StarkSDK.API.GetStarkDouyinCloudManager().CloudDb()
.GenDbCmd("num_int").Gte(3))

/// <summary>
/// 数据库操作符 in
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand In(List<object> listData);

List<object> inData = new List<object>();
inData.Add(2);
inData.Add(3);
inData.Add(4);
inData.Add(5);
inData.Add(111);
cmdList.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").In(inData));

/// <summary>
/// 数据库操作符 not in
/// </summary>
/// <param name="para"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand NIn(List<object> listData);

List<object> inData = new List<object>();
inData.Add(2);
inData.Add(3);
inData.Add(4);
inData.Add(5);
inData.Add(111);
cmdList.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").NIn(inData));

/// <summary>
/// 数据库操作符 And
/// </summary>
/// <param name="listData"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand And(List<CloudDBCommand> listData);

// 创建一个 andCmd 对象， 这个对象的参数为空 
CloudDBCommand andCmd1 = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("");
List<CloudDBCommand> andCmdList1 = new List<CloudDBCommand>();
andCmdList1.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").Eq(5));
andCmdList1.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_double").Eq(5.1));

// andCmdList1 列表中的 条件都做 And 操作
andCmd1.And(andCmdList1);


andCmd1 可以传递给cloudDBCollection去做查询操作
cloudDBCollection.AddWhereCmd(andCmd1);

/// <summary>
/// 数据库操作符 Or
/// </summary>
/// <param name="listData"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Or(List<CloudDBCommand> listData);

// 创建一个 andCmd 对象， 这个对象的参数为空 
CloudDBCommand cmd1 = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("");
List<CloudDBCommand> andCmdList1 = new List<CloudDBCommand>();
andCmdList1.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").Eq(5));
andCmdList1.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_double").Eq(5.1));

// andCmdList1 列表中的 条件都做 Or 操作
cmd1.Or(andCmdList1);


cmd1 可以传递给cloudDBCollection去做查询操作
cloudDBCollection.AddWhereCmd(cmd1);

/// <summary>
/// 数据库操作 Not or
/// </summary>
/// <param name="listData"></param>
/// <returns></returns>
[StarkVersion(MinSCAndroidVersion = "5.45.0", IsSupportWebGL = true)]
public CloudDBCommand Nor(List<CloudDBCommand> listData);

List<CloudDBCommand> norCmdList2 = new List<CloudDBCommand>();
norCmdList2.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").Eq(5));
norCmdList2.Add(StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("num_int").Eq(7));
CloudDBCommand norCmd2 = StarkSDK.API.GetStarkDouyinCloudManager().CloudDb().GenDbCmd("");

// andCmdList1 列表中的 条件都做 Nor 操作
norCmd2.Nor(norCmdList2);


norCmd2 可以传递给cloudDBCollection去做查询操作
cloudDBCollection.AddWhereCmd(norCmd2);