Sandbox::http://binary.ac.cn/weixin-java-miniapp-javadoc/cn/binarywang/wx/miniapp/api/WxMaCloudService.html

所有已知实现类:

WxMaCloudServiceImpl
```
public interface WxMaCloudService
```
云开发相关接口.

作者:

Binary Wang created on 2020 -01-22

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`List<String>`	`add(String collection, List<?> list)` 批量添加记录到集合。
`String`	`add(String collection, Object obj)` 添加单条记录到集合。
`WxCloudBatchDeleteFileResult`	`batchDeleteFile(String[] fileIds)` 删除文件。
`WxCloudBatchDeleteFileResult`	`batchDeleteFile(String env, String[] fileIds)` 删除文件。
`WxCloudBatchDownloadFileResult`	`batchDownloadFile(String[] fileIds, long[] maxAges)` 获取文件下载链接。
`WxCloudBatchDownloadFileResult`	`batchDownloadFile(String env, String[] fileIds, long[] maxAges)` 获取文件下载链接。
`Long`	`count(String collection, String whereJson)` 统计集合中符合条件的记录数。
`com.google.gson.JsonArray`	`databaseAdd(String query)` 数据库插入记录。
`com.google.gson.JsonArray`	`databaseAdd(String env, String query)` 数据库插入记录。
`com.google.gson.JsonArray`	`databaseAggregate(String query)` 数据库聚合记录。
`com.google.gson.JsonArray`	`databaseAggregate(String env, String query)` 数据库聚合记录。
`void`	`databaseCollectionAdd(String collectionName)` 新增集合。
`void`	`databaseCollectionAdd(String env, String collectionName)` 新增集合。
`void`	`databaseCollectionDelete(String collectionName)` 删除集合。
`void`	`databaseCollectionDelete(String env, String collectionName)` 删除集合。
`WxCloudDatabaseCollectionGetResult`	`databaseCollectionGet(Long limit, Long offset)` 获取特定云环境下集合信息。
`WxCloudDatabaseCollectionGetResult`	`databaseCollectionGet(String env, Long limit, Long offset)` 获取特定云环境下集合信息。
`Long`	`databaseCount(String query)` 统计集合记录数或统计查询语句对应的结果记录数。
`Long`	`databaseCount(String env, String query)` 统计集合记录数或统计查询语句对应的结果记录数。
`int`	`databaseDelete(String query)` 数据库删除记录。
`int`	`databaseDelete(String env, String query)` 数据库删除记录。
`Long`	`databaseMigrateExport(String filePath, int fileType, String query)` 数据库导出。
`Long`	`databaseMigrateExport(String env, String filePath, int fileType, String query)` 数据库导出。
`Long`	`databaseMigrateImport(String collectionName, String filePath, int fileType, boolean stopOnError, int conflictMode)` 数据库导入。
`Long`	`databaseMigrateImport(String env, String collectionName, String filePath, int fileType, boolean stopOnError, int conflictMode)` 数据库导入。
`WxCloudCloudDatabaseMigrateQueryInfoResult`	`databaseMigrateQueryInfo(Long jobId)` 数据库迁移状态查询。
`WxCloudCloudDatabaseMigrateQueryInfoResult`	`databaseMigrateQueryInfo(String env, Long jobId)` 数据库迁移状态查询。
`WxCloudDatabaseQueryResult`	`databaseQuery(String query)` 数据库查询记录。
`WxCloudDatabaseQueryResult`	`databaseQuery(String env, String query)` 数据库查询记录。
`WxCloudDatabaseUpdateResult`	`databaseUpdate(String query)` 数据库更新记录。
`WxCloudDatabaseUpdateResult`	`databaseUpdate(String env, String query)` 数据库更新记录。
`Integer`	`delete(String collection, String whereJson)` 删除集合中符合条件的记录。
`WxCloudGetQcloudTokenResult`	`getQcloudToken(long lifeSpan)` 获取腾讯云API调用凭证。
`String`	`invokeCloudFunction(String name, String body)` 触发云函数。
`String`	`invokeCloudFunction(String env, String name, String body)` 触发云函数。
`WxCloudDatabaseQueryResult`	`query(String collection, String whereJson, Map<String,String> orderBy, Integer skip, Integer limit)` 查询集合中的记录。
`WxCloudSendSmsV2Result`	`sendSmsV2(WxCloudSendSmsV2Request request)` 发送携带 URL Link 的短信。
`WxCloudDatabaseUpdateResult`	`update(String collection, String whereJson, String updateJson)` 更新集合中符合条件的记录。
`void`	`updateIndex(String collectionName, List<WxCloudDatabaseCreateIndexRequest> createIndexes, List<String> dropIndexNames)` 变更数据库索引。
`void`	`updateIndex(String env, String collectionName, List<WxCloudDatabaseCreateIndexRequest> createIndexes, List<String> dropIndexNames)` 变更数据库索引。
`WxCloudUploadFileResult`	`uploadFile(String path)` 获取文件上传链接。
`WxCloudUploadFileResult`	`uploadFile(String env, String path)` 获取文件上传链接。

- 方法详细资料
  - invokeCloudFunction
```
String invokeCloudFunction(String name,
                           String body)
                    throws WxErrorException
```
    触发云函数。注意：HTTP API 途径触发云函数不包含用户信息。
    
    参数:
    
    name - 云函数名称
    
    body - 云函数的传入参数，具体结构由开发者定义
    
    返回:
    
    云函数返回的buffer
    
    抛出:
    
    WxErrorException - 调用失败时抛出
  - 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
    
    参数:
    
    env - 云开发环境ID
    
    name - 云函数名称
    
    body - 云函数的传入参数，具体结构由开发者定义
    
    返回:
    
    云函数返回的buffer
    
    抛出:
    
    WxErrorException - 调用失败时抛出
  - add
```
List<String> add(String collection,
                 List<?> list)
          throws WxErrorException
```
    批量添加记录到集合。
    
    参数:
    
    collection - 集合名称
    
    list - 要添加的记录列表
    
    返回:
    
    插入成功的记录ID列表
    
    抛出:
    
    WxErrorException - 添加失败时抛出
  - add
```
String add(String collection,
           Object obj)
    throws WxErrorException
```
    添加单条记录到集合。
    
    参数:
    
    collection - 集合名称
    
    obj - 要添加的记录对象
    
    返回:
    
    插入成功的记录ID
    
    抛出:
    
    WxErrorException - 添加失败时抛出
  - databaseAdd
```
com.google.gson.JsonArray databaseAdd(String query)
                               throws WxErrorException
```
    数据库插入记录。
    
    参数:
    
    query - 数据库操作语句
    
    返回:
    
    插入成功的数据集合主键_id列表
    
    抛出:
    
    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
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    插入成功的数据集合主键_id列表
    
    抛出:
    
    WxErrorException - 插入失败时抛出
  - delete
```
Integer delete(String collection,
               String whereJson)
        throws WxErrorException
```
    删除集合中符合条件的记录。
    
    参数:
    
    collection - 集合名称
    
    whereJson - 查询条件JSON字符串
    
    返回:
    
    删除的记录数量
    
    抛出:
    
    WxErrorException - 删除失败时抛出
  - databaseDelete
```
int databaseDelete(String query)
            throws WxErrorException
```
    数据库删除记录。
    
    参数:
    
    query - 数据库操作语句
    
    返回:
    
    删除记录数量
    
    抛出:
    
    WxErrorException - 删除失败时抛出
  - databaseDelete
```
int databaseDelete(String env,
                   String query)
            throws WxErrorException
```
    数据库删除记录。文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    删除记录数量
    
    抛出:
    
    WxErrorException - 删除失败时抛出
  - update
```
WxCloudDatabaseUpdateResult update(String collection,
                                   String whereJson,
                                   String updateJson)
                            throws WxErrorException
```
    更新集合中符合条件的记录。
    
    参数:
    
    collection - 集合名称
    
    whereJson - 查询条件JSON字符串
    
    updateJson - 更新内容JSON字符串
    
    返回:
    
    更新结果对象
    
    抛出:
    
    WxErrorException - 更新失败时抛出
  - databaseUpdate
```
WxCloudDatabaseUpdateResult databaseUpdate(String query)
                                    throws WxErrorException
```
    数据库更新记录。
    
    参数:
    
    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
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    更新结果对象
    
    抛出:
    
    WxErrorException - 更新失败时抛出
  - query
```
WxCloudDatabaseQueryResult query(String collection,
                                 String whereJson,
                                 Map<String,String> orderBy,
                                 Integer skip,
                                 Integer limit)
                          throws WxErrorException
```
    查询集合中的记录。示例： db.collection('geo') .where({price: _.gt(10)}) .orderBy('_id', 'asc') .orderBy('price', 'desc') .skip(1) .limit(10) .get()
    
    参数:
    
    collection - 集合名称
    
    whereJson - 查询条件JSON字符串
    
    orderBy - 排序条件Map
    
    skip - 跳过记录数
    
    limit - 限制返回记录数
    
    返回:
    
    查询结果对象
    
    抛出:
    
    WxErrorException - 查询失败时抛出
  - databaseQuery
```
WxCloudDatabaseQueryResult databaseQuery(String query)
                                  throws WxErrorException
```
    数据库查询记录。
    
    参数:
    
    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
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    查询结果对象
    
    抛出:
    
    WxErrorException - 查询失败时抛出
  - databaseAggregate
```
com.google.gson.JsonArray databaseAggregate(String query)
                                     throws WxErrorException
```
    数据库聚合记录。
    
    参数:
    
    query - 数据库操作语句
    
    返回:
    
    聚合结果JSON数组
    
    抛出:
    
    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
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    聚合结果JSON数组
    
    抛出:
    
    WxErrorException - 聚合失败时抛出
  - count
```
Long count(String collection,
           String whereJson)
    throws WxErrorException
```
    统计集合中符合条件的记录数。
    
    参数:
    
    collection - 集合名称
    
    whereJson - 查询条件JSON字符串
    
    返回:
    
    记录数量
    
    抛出:
    
    WxErrorException - 统计失败时抛出
  - databaseCount
```
Long databaseCount(String query)
            throws WxErrorException
```
    统计集合记录数或统计查询语句对应的结果记录数。
    
    参数:
    
    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
    
    参数:
    
    env - 云环境ID
    
    query - 数据库操作语句
    
    返回:
    
    记录数量
    
    抛出:
    
    WxErrorException - 统计失败时抛出
  - updateIndex
```
void updateIndex(String collectionName,
                 List<WxCloudDatabaseCreateIndexRequest> createIndexes,
                 List<String> dropIndexNames)
          throws WxErrorException
```
    变更数据库索引。
    
    参数:
    
    collectionName - 集合名称
    
    createIndexes - 新增索引对象列表
    
    dropIndexNames - 要删除的索引名称列表
    
    抛出:
    
    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
    
    参数:
    
    env - 云环境ID
    
    collectionName - 集合名称
    
    createIndexes - 新增索引对象列表
    
    dropIndexNames - 要删除的索引名称列表
    
    抛出:
    
    WxErrorException - 更新失败时抛出
  - databaseMigrateImport
```
Long databaseMigrateImport(String collectionName,
                           String filePath,
                           int fileType,
                           boolean stopOnError,
                           int conflictMode)
                    throws WxErrorException
```
    数据库导入。
    
    参数:
    
    collectionName - 导入collection名
    
    filePath - 导入文件路径
    
    fileType - 导入文件类型，1：JSON，2：CSV
    
    stopOnError - 是否在遇到错误时停止导入
    
    conflictMode - 冲突处理模式，1：INSERT，2：UPSERT
    
    返回:
    
    任务ID
    
    抛出:
    
    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 注意：导入文件需先上传到同环境的存储中，可使用开发者工具或HTTP API的上传文件API上传
    
    参数:
    
    env - 云环境ID
    
    collectionName - 导入collection名
    
    filePath - 导入文件路径
    
    fileType - 导入文件类型，1：JSON，2：CSV
    
    stopOnError - 是否在遇到错误时停止导入
    
    conflictMode - 冲突处理模式，1：INSERT，2：UPSERT
    
    返回:
    
    任务ID
    
    抛出:
    
    WxErrorException - 导入失败时抛出
  - databaseMigrateExport
```
Long databaseMigrateExport(String filePath,
                           int fileType,
                           String query)
                    throws WxErrorException
```
    数据库导出。
    
    参数:
    
    filePath - 导出文件路径
    
    fileType - 导出文件类型，1：JSON，2：CSV
    
    query - 导出条件
    
    返回:
    
    任务ID
    
    抛出:
    
    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 注意：文件会导出到同环境的云存储中，可使用获取下载链接API获取下载链接
    
    参数:
    
    env - 云环境ID
    
    filePath - 导出文件路径
    
    fileType - 导出文件类型，1：JSON，2：CSV
    
    query - 导出条件
    
    返回:
    
    任务ID
    
    抛出:
    
    WxErrorException - 导出失败时抛出
  - databaseMigrateQueryInfo
```
WxCloudCloudDatabaseMigrateQueryInfoResult databaseMigrateQueryInfo(Long jobId)
                                                             throws WxErrorException
```
    数据库迁移状态查询。
    
    参数:
    
    jobId - 迁移任务ID
    
    返回:
    
    迁移状态查询结果
    
    抛出:
    
    WxErrorException - 查询失败时抛出
  - databaseMigrateQueryInfo
```
WxCloudCloudDatabaseMigrateQueryInfoResult databaseMigrateQueryInfo(String env,
                                                                    Long jobId)
                                                             throws WxErrorException
```
    数据库迁移状态查询。文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html
    
    参数:
    
    env - 云环境ID
    
    jobId - 迁移任务ID
    
    返回:
    
    迁移状态查询结果
    
    抛出:
    
    WxErrorException - 查询失败时抛出
  - uploadFile
```
WxCloudUploadFileResult uploadFile(String path)
                            throws WxErrorException
```
    获取文件上传链接。
    
    参数:
    
    path - 上传路径
    
    返回:
    
    上传结果对象
    
    抛出:
    
    WxErrorException - 获取失败时抛出
  - uploadFile
```
WxCloudUploadFileResult uploadFile(String env,
                                   String path)
                            throws WxErrorException
```
    获取文件上传链接。文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
    
    参数:
    
    env - 云环境ID
    
    path - 上传路径
    
    返回:
    
    上传结果对象
    
    抛出:
    
    WxErrorException - 获取失败时抛出
  - batchDownloadFile
```
WxCloudBatchDownloadFileResult batchDownloadFile(String[] fileIds,
                                                 long[] maxAges)
                                          throws WxErrorException
```
    获取文件下载链接。
    
    参数:
    
    fileIds - 文件ID数组
    
    maxAges - 下载链接有效期数组，对应文件id列表
    
    返回:
    
    下载链接信息对象
    
    抛出:
    
    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
    
    参数:
    
    env - 云环境ID
    
    fileIds - 文件ID数组
    
    maxAges - 下载链接有效期数组，对应文件id列表
    
    返回:
    
    下载链接信息对象
    
    抛出:
    
    WxErrorException - 获取失败时抛出
  - batchDeleteFile
```
WxCloudBatchDeleteFileResult batchDeleteFile(String[] fileIds)
                                      throws WxErrorException
```
    删除文件。
    
    参数:
    
    fileIds - 文件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
    
    参数:
    
    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
    
    参数:
    
    lifeSpan - 有效期（单位为秒，最大7200）
    
    返回:
    
    腾讯云Token结果对象
    
    抛出:
    
    WxErrorException - 获取失败时抛出
  - databaseCollectionAdd
```
void databaseCollectionAdd(String collectionName)
                    throws WxErrorException
```
    新增集合。
    
    参数:
    
    collectionName - 集合名称
    
    抛出:
    
    WxErrorException - 新增失败时抛出
  - databaseCollectionAdd
```
void databaseCollectionAdd(String env,
                           String collectionName)
                    throws WxErrorException
```
    新增集合。文档地址：https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
    
    参数:
    
    env - 云环境ID
    
    collectionName - 集合名称
    
    抛出:
    
    WxErrorException - 新增失败时抛出
  - databaseCollectionDelete
```
void databaseCollectionDelete(String collectionName)
                       throws WxErrorException
```
    删除集合。
    
    参数:
    
    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
    
    参数:
    
    env - 云环境ID
    
    collectionName - 集合名称
    
    抛出:
    
    WxErrorException - 删除失败时抛出
  - databaseCollectionGet
```
WxCloudDatabaseCollectionGetResult databaseCollectionGet(Long limit,
                                                         Long offset)
                                                  throws WxErrorException
```
    获取特定云环境下集合信息。
    
    参数:
    
    limit - 获取数量限制，默认值：10
    
    offset - 偏移量，默认值：0
    
    返回:
    
    集合信息获取结果对象
    
    抛出:
    
    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
    
    参数:
    
    env - 云环境ID
    
    limit - 获取数量限制，默认值：10
    
    offset - 偏移量，默认值：0
    
    返回:
    
    集合信息获取结果对象
    
    抛出:
    
    WxErrorException - 获取失败时抛出
  - sendSmsV2
```
WxCloudSendSmsV2Result sendSmsV2(WxCloudSendSmsV2Request request)
                          throws WxErrorException
```
    发送携带 URL Link 的短信。文档地址：https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/cloudbase/cloudbase.sendSmsV2.html
    
    参数:
    
    request - 短信发送请求对象
    
    返回:
    
    短信发送结果对象
    
    抛出:
    
    WxErrorException - 发送失败时抛出

接口 WxMaCloudService

方法概要

方法详细资料

invokeCloudFunction

invokeCloudFunction

add

add

databaseAdd

databaseAdd

delete

databaseDelete

databaseDelete

update

databaseUpdate

databaseUpdate

query

databaseQuery

databaseQuery

databaseAggregate

databaseAggregate

count

databaseCount

databaseCount

updateIndex

updateIndex

databaseMigrateImport

databaseMigrateImport

databaseMigrateExport

databaseMigrateExport

databaseMigrateQueryInfo

databaseMigrateQueryInfo

uploadFile

uploadFile

batchDownloadFile

batchDownloadFile

batchDeleteFile

batchDeleteFile

getQcloudToken

databaseCollectionAdd

databaseCollectionAdd

databaseCollectionDelete

databaseCollectionDelete

databaseCollectionGet

databaseCollectionGet

sendSmsV2