cn.binarywang.wx.miniapp.api

接口 WxMaCloudService

所有已知实现类:

WxMaCloudServiceImpl

public interface WxMaCloudService

云开发相关接口.

作者:

Binary Wang

字段概要

字段

限定符和类型	字段和说明
static String	BATCH_DELETE_FILE_URL
static String	DATABASE_ADD_URL
static String	DATABASE_AGGREGATE_URL
static String	DATABASE_COLLECTION_ADD_URL
static String	DATABASE_COLLECTION_DELETE_URL
static String	DATABASE_COLLECTION_GET_URL
static String	DATABASE_COUNT_URL
static String	DATABASE_DELETE_URL
static String	DATABASE_MIGRATE_EXPORT_URL
static String	DATABASE_MIGRATE_IMPORT_URL
static String	DATABASE_MIGRATE_QUERY_INFO_URL
static String	DATABASE_QUERY_URL
static String	DATABASE_UPDATE_URL
static String	GET_QCLOUD_TOKEN_URL
static String	INVOKE_CLOUD_FUNCTION_URL
static String	UPDATE_INDEX_URL
static String	UPLOAD_FILE_URL

方法概要

限定符和类型	方法和说明
WxCloudBatchDeleteFileResult	batchDeleteFile(String env, String[] fileIds) 删除文件 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html 请求地址：POST https://api.weixin.qq.com/tcb/batchdeletefile?
WxCloudBatchDownloadFileResult	batchDownloadFile(String env, String[] fileIds, long[] maxAges) 获取文件下载链接 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html 请求地址：POST https://api.weixin.qq.com/tcb/batchdownloadfile?
com.google.gson.JsonArray	databaseAdd(String env, String query) 数据库插入记录 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html 请求地址：POST https://api.weixin.qq.com/tcb/databaseadd?
com.google.gson.JsonArray	databaseAggregate(String env, String query) 数据库聚合记录 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAggregate.html 请求地址：POST https://api.weixin.qq.com/tcb/databaseaggregate?
void	databaseCollectionAdd(String env, String collectionName) 新增集合 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionadd?
void	databaseCollectionDelete(String env, String collectionName) 删除集合 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionadd?
WxCloudDatabaseCollectionGetResult	databaseCollectionGet(String env, Long limit, Long offset) 获取特定云环境下集合信息 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionget?
Long	databaseCount(String env, String query) 统计集合记录数或统计查询语句对应的结果记录数 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html 请求地址：POST https://api.weixin.qq.com/tcb/databasecount?
int	databaseDelete(String env, String query) 数据库删除记录 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html 请求地址：POST https://api.weixin.qq.com/tcb/databasedelete?
Long	databaseMigrateExport(String env, String filePath, int fileType, String query) 数据库导出 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html 请求地址： POST https://api.weixin.qq.com/tcb/databasemigrateexport?
Long	databaseMigrateImport(String env, String collectionName, String filePath, int fileType, boolean stopOnError, int conflictMode) 数据库导入 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html 请求地址： POST https://api.weixin.qq.com/tcb/databasemigrateimport?
WxCloudCloudDatabaseMigrateQueryInfoResult	databaseMigrateQueryInfo(String env, Long jobId) 数据库迁移状态查询 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html 请求地址：POST https://api.weixin.qq.com/tcb/databasemigratequeryinfo?
WxCloudDatabaseQueryResult	databaseQuery(String env, String query) 数据库查询记录 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html 请求地址：POST https://api.weixin.qq.com/tcb/databasequery?
WxCloudDatabaseUpdateResult	databaseUpdate(String env, String query) 数据库更新记录 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html 请求地址：POST https://api.weixin.qq.com/tcb/databaseupdate?
WxCloudGetQcloudTokenResult	getQcloudToken(long lifeSpan) 获取腾讯云API调用凭证 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/utils/getQcloudToken.html 请求地址：POST https://api.weixin.qq.com/tcb/getqcloudtoken?
String	invokeCloudFunction(String env, String name, String body) 触发云函数。
void	updateIndex(String env, String collectionName, List<WxCloudDatabaseCreateIndexRequest> createIndexes, List<String> dropIndexNames) 变更数据库索引 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html 请求地址：POST https://api.weixin.qq.com/tcb/updateindex?
WxCloudUploadFileResult	uploadFile(String env, String path) 获取文件上传链接 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html 请求地址：POST https://api.weixin.qq.com/tcb/uploadfile?

字段详细资料

INVOKE_CLOUD_FUNCTION_URL

static final String INVOKE_CLOUD_FUNCTION_URL

另请参阅:

常量字段值

DATABASE_COLLECTION_GET_URL

static final String DATABASE_COLLECTION_GET_URL

另请参阅:

常量字段值

DATABASE_COLLECTION_DELETE_URL

static final String DATABASE_COLLECTION_DELETE_URL

另请参阅:

常量字段值

DATABASE_COLLECTION_ADD_URL

static final String DATABASE_COLLECTION_ADD_URL

另请参阅:

常量字段值

GET_QCLOUD_TOKEN_URL

static final String GET_QCLOUD_TOKEN_URL

另请参阅:

常量字段值

BATCH_DELETE_FILE_URL

static final String BATCH_DELETE_FILE_URL

另请参阅:

常量字段值

UPLOAD_FILE_URL

static final String UPLOAD_FILE_URL

另请参阅:

常量字段值

DATABASE_MIGRATE_QUERY_INFO_URL

static final String DATABASE_MIGRATE_QUERY_INFO_URL

另请参阅:

常量字段值

DATABASE_MIGRATE_EXPORT_URL

static final String DATABASE_MIGRATE_EXPORT_URL

另请参阅:

常量字段值

DATABASE_MIGRATE_IMPORT_URL

static final String DATABASE_MIGRATE_IMPORT_URL

另请参阅:

常量字段值

UPDATE_INDEX_URL

static final String UPDATE_INDEX_URL

另请参阅:

常量字段值

DATABASE_COUNT_URL

static final String DATABASE_COUNT_URL

另请参阅:

常量字段值

DATABASE_AGGREGATE_URL

static final String DATABASE_AGGREGATE_URL

另请参阅:

常量字段值

DATABASE_QUERY_URL

static final String DATABASE_QUERY_URL

另请参阅:

常量字段值

DATABASE_UPDATE_URL

static final String DATABASE_UPDATE_URL

另请参阅:

常量字段值

DATABASE_DELETE_URL

static final String DATABASE_DELETE_URL

另请参阅:

常量字段值

DATABASE_ADD_URL

static final String DATABASE_ADD_URL

另请参阅:

常量字段值

方法详细资料

invokeCloudFunction

String invokeCloudFunction(String env,
                           String name,
                           String body)
                    throws WxErrorException

 触发云函数。注意：HTTP API 途径触发云函数不包含用户信息。
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/functions/invokeCloudFunction.html

 请求地址
 POST https://api.weixin.qq.com/tcb/invokecloudfunction?access_token=ACCESS_TOKEN&env=ENV&name=FUNCTION_NAME

 

参数:

env - string 是 云开发环境ID

name - string 是 云函数名称

body - string 是 云函数的传入参数，具体结构由开发者定义。

返回:

resp_data string 云函数返回的buffer

抛出:

WxErrorException - .

databaseAdd

com.google.gson.JsonArray databaseAdd(String env,
                                      String query)
                               throws WxErrorException

 数据库插入记录

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html
 请求地址：POST https://api.weixin.qq.com/tcb/databaseadd?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

插入成功的数据集合主键_id

抛出:

WxErrorException - .

databaseDelete

int databaseDelete(String env,
                   String query)
            throws WxErrorException

 数据库删除记录

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasedelete?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

删除记录数量

抛出:

WxErrorException - .

databaseUpdate

WxCloudDatabaseUpdateResult databaseUpdate(String env,
                                           String query)
                                    throws WxErrorException

 数据库更新记录

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html
 请求地址：POST https://api.weixin.qq.com/tcb/databaseupdate?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

.

抛出:

WxErrorException - .

databaseQuery

WxCloudDatabaseQueryResult databaseQuery(String env,
                                         String query)
                                  throws WxErrorException

 数据库查询记录

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasequery?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

.

抛出:

WxErrorException - .

databaseAggregate

com.google.gson.JsonArray databaseAggregate(String env,
                                            String query)
                                     throws WxErrorException

 数据库聚合记录

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAggregate.html
 请求地址：POST https://api.weixin.qq.com/tcb/databaseaggregate?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

.

抛出:

WxErrorException - .

databaseCount

Long databaseCount(String env,
                   String query)
            throws WxErrorException

 统计集合记录数或统计查询语句对应的结果记录数

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasecount?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

query - 数据库操作语句

返回:

记录数量

抛出:

WxErrorException - .

updateIndex

void updateIndex(String env,
                 String collectionName,
                 List<WxCloudDatabaseCreateIndexRequest> createIndexes,
                 List<String> dropIndexNames)
          throws WxErrorException

 变更数据库索引

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html
 请求地址：POST https://api.weixin.qq.com/tcb/updateindex?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

collectionName - 集合名称

createIndexes - 新增索引对象

dropIndexNames - 要删除的索引的名字

抛出:

WxErrorException - .

databaseMigrateImport

Long databaseMigrateImport(String env,
                           String collectionName,
                           String filePath,
                           int fileType,
                           boolean stopOnError,
                           int conflictMode)
                    throws WxErrorException

 数据库导入

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html
 请求地址： POST https://api.weixin.qq.com/tcb/databasemigrateimport?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

collectionName - 导入collection名

filePath - 导入文件路径(导入文件需先上传到同环境的存储中，可使用开发者工具或 HTTP API的上传文件 API上传）

fileType - 导入文件类型， 1 JSON， 2 CSV

stopOnError - 是否在遇到错误时停止导入

conflictMode - 冲突处理模式 ： 1 INSERT , 2 UPSERT

返回:

jobId

抛出:

WxErrorException - .

databaseMigrateExport

Long databaseMigrateExport(String env,
                           String filePath,
                           int fileType,
                           String query)
                    throws WxErrorException

 数据库导出

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html
 请求地址： POST https://api.weixin.qq.com/tcb/databasemigrateexport?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

filePath - 导出文件路径（文件会导出到同环境的云存储中，可使用获取下载链接 API 获取下载链接）

fileType - 导出文件类型， 1 JSON， 2 CSV

query - 导出条件

返回:

jobId

抛出:

WxErrorException - .

databaseMigrateQueryInfo

WxCloudCloudDatabaseMigrateQueryInfoResult databaseMigrateQueryInfo(String env,
                                                                    Long jobId)
                                                             throws WxErrorException

   数据库迁移状态查询

  文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html
  请求地址：POST https://api.weixin.qq.com/tcb/databasemigratequeryinfo?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

jobId - 迁移任务ID

返回:

.

抛出:

WxErrorException - .

uploadFile

WxCloudUploadFileResult uploadFile(String env,
                                   String path)
                            throws WxErrorException

 获取文件上传链接

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
 请求地址：POST https://api.weixin.qq.com/tcb/uploadfile?access_token=ACCESS_TOKEN

 

参数:

env - 云环境ID

path - 上传路径

返回:

上传结果

抛出:

WxErrorException - .

batchDownloadFile

WxCloudBatchDownloadFileResult batchDownloadFile(String env,
                                                 String[] fileIds,
                                                 long[] maxAges)
                                          throws WxErrorException

 获取文件下载链接

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html
 请求地址：POST https://api.weixin.qq.com/tcb/batchdownloadfile?access_token=ACCESS_TOKEN

 

参数:

env - 云环境ID

fileIds - 文件ID列表

maxAges - 下载链接有效期列表，对应文件id列表

返回:

下载链接信息

抛出:

WxErrorException - .

batchDeleteFile

WxCloudBatchDeleteFileResult batchDeleteFile(String env,
                                             String[] fileIds)
                                      throws WxErrorException

 删除文件

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html
 请求地址：POST https://api.weixin.qq.com/tcb/batchdeletefile?access_token=ACCESS_TOKEN

 

参数:

env - 云环境ID

fileIds - 文件ID列表

返回:

下载链接信息

抛出:

WxErrorException - .

getQcloudToken

WxCloudGetQcloudTokenResult getQcloudToken(long lifeSpan)
                                    throws WxErrorException

  获取腾讯云API调用凭证

  文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/utils/getQcloudToken.html
  请求地址：POST https://api.weixin.qq.com/tcb/getqcloudtoken?access_token=ACCESS_TOKEN
 

参数:

lifeSpan - 有效期（单位为秒，最大7200）

返回:

.

抛出:

WxErrorException - .

databaseCollectionAdd

void databaseCollectionAdd(String env,
                           String collectionName)
                    throws WxErrorException

 新增集合

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionadd?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

collectionName - 集合名称

抛出:

WxErrorException - .

databaseCollectionDelete

void databaseCollectionDelete(String env,
                              String collectionName)
                       throws WxErrorException

 删除集合

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionadd?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

collectionName - 集合名称

抛出:

WxErrorException - .

databaseCollectionGet

WxCloudDatabaseCollectionGetResult databaseCollectionGet(String env,
                                                         Long limit,
                                                         Long offset)
                                                  throws WxErrorException

 获取特定云环境下集合信息

 文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html
 请求地址：POST https://api.weixin.qq.com/tcb/databasecollectionget?access_token=ACCESS_TOKEN
 

参数:

env - 云环境ID

limit - 获取数量限制，默认值：10

offset - 偏移量,默认值：0

返回:

.

抛出:

WxErrorException - .