@cloudbase/js-sdk 能让您可以在 Web 端(例如 PC Web 页面、微信公众平台 H5 等)使用 JavaScript 访问 Cloudbase 服务和资源。
#npm
npm install @cloudbase/js-sdk -S
# yarn
yarn add @cloudbase/js-sdk
通过 CDN 引入有两种方式:
<script src="//imgcache.qq.com/qcloud/cloudbase-js-sdk/${version}/cloudbase.full.js"></script>
<script>
const app = cloudbase.init({
env: "your-env-id"
});
</script>
CloudBase Flutter SDK 提供一系列插件,可以根据场景按需安装。
Plugin | Version | 文档 | 描述 |
---|---|---|---|
cloudbase_core | CloudBase Core | 核心库,初始化环境等 | |
cloudbase_auth | CloudBase Auth | 鉴权库,支持微信登录、自定义登录、匿名登录等 | |
cloudbase_function | CloudBase Function | 支持云函数能力 | |
cloudbase_storage | CloudBase Storage | 支持对象存储能力 | |
cloudbase_database | CloudBase Database | 支持文档型数据库能力 |
在 flutter 项目的 pubspec.yaml
文件的 dependencies
中添加需要的插件,例如:
dependencies:
cloudbase_core: ^0.0.9
cloudbase_auth: ^0.0.11
cloudbase_function: ^0.0.2
cloudbase_storage: ^0.0.3
cloudbase_database: ^0.0.10
然后在命令行中运行。
flutter pub get
微信小程序的 SDK,已经直接内置到微信小程序运行框架内,无需额外引用,节省空间。通过微信小程序 SDK,您可以在微信小程序中直接访问 CloudBase 的服务。
QQ 小程序的 SDK,已经直接内置到 QQ 小程序运行框架内,无需额外引用,节省空间。通过 QQ 小程序 SDK,您可以在QQ 小程序中直接访问 CloudBase 的服务。
安装
在命令行中给项目添加依赖。
dotnet add package TencentCloudBase
Cloudbase Server Node.js SDK 让您可以在服务端(例如腾讯云云函数或云服务器等)使用 Node.js 服务访问 TCB 的服务,如云函数调用,文件上传下载,数据库集合文档操作等,方便快速搭建应用。
需要 Node.js v8.9 及以上版本。
Cloudbase Server Node.js SDK 可以通过 npm 安装:
npm install --save @cloudbase/node-sdk
云开发 manager-node sdk 支持开发者通过接口形式对云开发提供的云函数、数据库、文件存储等资源进行创建、管理、配置等操作。更多源码内容请参见 cloudbase-manager-node。
npm
npm install @cloudbase/manager-node
yarn
yarn add @cloudbase/manager-node
TCB 提供开发应用所需服务和基础设施。tcb-php-sdk 让你可以在服务端(如腾讯云云函数或 CVM 等)使用 php 服务访问 TCB 的的服务。
需要 php7 及以上版本。
使用 composer (opens new window)安装 CloudBase PHP SDK:
composer require tcb-php-sdk
提示
国内使用时,可切换为国内镜像:
composer config -g repo.packagist composer https://packagist.phpcomposer.com
在代码中使用:
require 'vendor/autoload.php';
use TencentCloudBase\TCB as TCB;
$tcb = new TCB([]);
T云开发 tcb-manager-php SDK 支持开发者通过接口形式对云开发提供的云函数、数据库、文件存储资源进行创建、管理、配置等操作。更多源码内容请参见 tcb-manager-php SDK (opens new window)。
云开发 tcb-manager-php SDK 的安装方式有两种,通过 composer 安装和手动安装源码包。
composer require tencentcloudbase/tcb-manager-php
如果项目使用 composer 管理依赖,则会自动引入,可跳过此步骤。
require_once "/path/to/tcb-manager-php/autoload.php"
引用 SDK 后即可使用,SDK 命名空间为 TcbManager。
js-sdk | Flutter | .NET | wx | node-sdk | php | wx-server-sdk |
---|---|---|---|---|---|---|
init | CloudBaseCore init({env,appAccess{},timeout}) | CloudBaseApp.Init | wx.cloud.init({env,traceUser})new cloud.Cloud | cloud.init | new Tcb() | cloud.init |
Auth(认证)/LoginState(登录) | Auth | |||||
Auth | Auth | Auth | Auth | |||
currentUser | ||||||
getCurrentUser | getUserInfo | GetUserInfoAsync | ||||
hasLoginState | getAuthState | GetAuthStateAsync | ||||
getLoginState | ||||||
weixinAuthProvider({appid,scope}) | ||||||
customAuthProvider | signInWithTicket | SignInWithTicketAsync | ||||
anonymousAuthProvider | signInAnonymously | SignInAnonymouslyAsync | ||||
signUpWithEmailAndPassword(email,password) | ||||||
signInWithEmailAndPassword(email,password) | ||||||
sendPasswordResetEmail(email) | ||||||
signInWithUsernameAndPassword(username,password) | ||||||
isUsernameRegistered(username) | ||||||
sendPhoneCode(phoneNumber) | ||||||
signUpWithPhoneCode(phoneNumber,phoneCode,password) | ||||||
signInWithPhoneCodeOrPassword(phoneNumber,phoneCode,password) | ||||||
signOut | signOut | SignOutAsync | ||||
getAuthHeader | ||||||
getAuthHeaderAsync | ||||||
shouldRefreshAccessToken | ||||||
onLoginStateChanged | ||||||
onLoginStateExpired | ||||||
onAccessTokenRefreshed | ||||||
onAnonymousConverted | ||||||
onLoginTypeChanged | getUserInfo | |||||
getEndUserInfo | ||||||
getClientIP | ||||||
createTicket | ||||||
LoginState | authState | authState | ||||
User | ||||||
update(nickName,gender,avatarUrl,country,province,city) | ||||||
refresh() | ||||||
linkWithTicket(ticket) | ||||||
linkWithRedirect({appid,scope}) | ||||||
updatePassword(newPassword,oldPassword) | ||||||
updateEmail(newEmail) | ||||||
updateUsername(newUsername) | ||||||
linkWithPhoneNumber(phoneNumber,phoneCode) | ||||||
updatePhoneNumber(phoneNumber,phoneCode) | ||||||
unlink(loginType) | ||||||
WeixinAuthProvider | ||||||
signInWithRedirect | signInByWx | |||||
getRedirectResult | ||||||
getLinkRedirectResult | ||||||
linkWithRedirect | ||||||
CustomAuthProvider | ||||||
signIn(ticket) | ||||||
AnonymousAuthProvider | ||||||
signIn() |
js-sdk | Flutter | .NET | 小程序端 | node-sdk | php | wx-server-sdk |
---|---|---|---|---|---|---|
database | CloudBaseDatabase | Db | database | database | getDatabase() | database |
collection(name) | collection(name) | Collection(name) | collection(name) | collection(name) | collection(name) | |
RegExp | RegExp | $db->RegExp | RegExp | |||
serverDate | serverDate | serverDate | ||||
createCollection | createCollection | createCollection | ||||
doc | doc | Doc | Doc | Doc | Doc | Doc |
where(obj) | where(obj) | Where(obj) | where(obj) | where(obj) | where(obj) | where(obj) |
limit(number) | limit(number) | Limit(number) | limit(number) | limit(number) | limit(number) | limit(number) |
skip(number) | skip(number) | Skip(number) | skip(number) | skip(number) | skip(number) | skip(number) |
field(obj) | field(obj) | Field(obj) | field(obj) | field(obj) | field(obj) | field(obj) |
orderBy(field, orderType) | orderBy(field, orderType) | orderBy(field, orderType) | orderBy(field, orderType) | orderBy(field, orderType) | orderBy(field, orderType) | orderBy(field, orderType) |
options | options | |||||
add | add | Add | add | add | add | add |
get | get | Get | get | get | get | get |
count | count | Count | count | count | count | count |
remove | remove | Remove | remove | remove | remove | remove |
update/set | update/set | Update/Set | update/set | update/set | update/set | update/set |
updateAndReturn | ||||||
Geo | Geo | Geo | Geo | Geo | ||
Point | Point | Point | Point | Point | Point | |
LineString | LineString | LineString | LineString | LineString | LineString | |
Polygon | Polygon | Polygon | Polygon | Polygon | Polygon | |
MultiPoint | MultiPoint | MultiPoint | MultiPoint | MultiPoint | MultiPoint | |
MultiLineString | MultiLineString | MultiLineString | MultiLineString | MultiLineString | MultiLineString | |
MultiPolygon | MultiPolygon | MultiPolygon | MultiPolygon | MultiPolygon | MultiPolygon | |
Aggregate | Aggregate | Aggregate | ||||
addFields | addFields | addFields | ||||
bucket | bucket | bucket | ||||
bucketAuto | bucketAuto | bucketAuto | ||||
count | count | count | ||||
geoNear | geoNear | geoNear | ||||
group | group | group | ||||
limt | limt | limt | ||||
lookup | lookup | |||||
match | match | match | ||||
project | project | project | ||||
replaceRoot | replaceRoot | replaceRoot | ||||
sample | sample | sample | ||||
skip | skip | skip | ||||
sort | sort | sort | ||||
sortByCount | sortByCount | sortByCount | ||||
unwind | unwind | unwind | ||||
end | end | end | ||||
command | command | Command | Command | Command | Command | Command |
eq | eq | Eq | eq | eq | eq | eq |
neq | neq | Neq | neq | neq | neq | neq |
gt | gt | Gt | gt | gt | gt | gt |
gte | gte | Gte | gte | gte | gte | gte |
lt | lt | Lt | lt | lt | lt | lt |
lte | lte | Lte | Lte | lte | lte | lte |
in | into | In | in | in | in | in |
nin | nin | Nin | nin | nin | nin | nin |
and | and | And | and | and | and | and |
or | or | Or | or | or | or | or |
not | not | |||||
neq | neq | |||||
RegExp | RegExp | RegExp | 小程序可直接用 | RegExp | $db->RegExp | RegExp |
set | set | Set | set | set | set | set |
inc | inc | Inc | inc | inc | inc | inc |
mul | mul | Mul | mul | mul | mul | mul |
remove | remove | Remove | remove | remove | remove | remove |
min | min | |||||
max | max | |||||
rename | rename | |||||
push | push | Push | push | push | push | push |
pop | pop | Pop | pop | pop | pop | pop |
unshift | unshift | Unshift | unshift | unshift | unshift | unshift |
shift | shift | Shift | shift | shift | shift | shift |
pull | pull | |||||
pullAll | pullAll | |||||
addToSet | addToSet | |||||
all | all | |||||
eleMatch | eleMatch | |||||
size | size | |||||
geoNear | geoNear | geoNear | geoNear | geoNear | geoNear | |
geoWithin | geoWithin | geoWithin | geoWithin | geoWithin | geoWithin | |
geoIntersects | geoIntersects | geoIntersects | geoIntersects | geoIntersects | geoIntersects | |
expr | ||||||
aggregate | aggregate | |||||
算数运算符 | 算数运算符 | |||||
数组运算符 | 数组运算符 | |||||
布尔运算符 | 布尔运算符 | |||||
比较运算符 | 比较运算符 | |||||
条件操作符 | 条件操作符 | |||||
日期操作符 | 日期操作符 | |||||
对象操作符 | 对象操作符 | |||||
集合操作符 | 集合操作符 | |||||
字符串操作符 | 字符串操作符 | |||||
累计器操作符 | 累计器操作符 | |||||
变量操作符 | 变量操作符 | |||||
watch | watch | watch | ||||
startTransaction | startTransaction | |||||
runTransaction | runTransaction | |||||
rollback | rollback |
js-sdk | Flutter | .NET | 小程序端 | node-sdk | php | wx-server-sdk |
---|---|---|---|---|---|---|
callFunction | callFunction | CallFunctionAsync | wx.callFunction | cloud.callFunction | $functions = $tcb->->getFunctions()$result = $functions->callFunction | cloud.callFunction |
js-sdk | Flutter | .NET | 小程序端 | node-sdk | php | wx-server-sdk | |
---|---|---|---|---|---|---|---|
uploadFile(cloudPath,filePath,onUploadProgress) | uploadFile({String cloudPath, String filePath,(int count, int total) onProcess}) | UploadFileAsync(string cloudPath, string filePath) | wx.cloud.uploadFile | uploadFile(object) | uploadFile(object) | uploadFile(object) | |
getTempFileURL | getFileDownloadURL(List fileIdList) | GetFileDownloadUrlAsync(List fileIdList) | wx.cloud.getTempFileURL | getTempFileURL(object) | getTempFileURL(object) | getTempFileURL(object) | |
deleteFile | deleteFiles(List fileIdList) | DeleteFilesAsync(List fileIdList) | wx.cloud.deleteFile | deletefile(object) | deletefile(object) | deletefile(object) | |
downloadFile | downloadFile({String fileId, String savePath,(int count, int total) onProcess}) | wx.cloud.downloadFile | downloadFile(object) | downloadFile(object) | downloadFile(object) | ||
getUploadMetadata(String cloudPath) |
公众号H5的功能基本与小程序端一致,新增checkLogin
,startLogin
,getJSSDKSignature
,refreshAuth
等公众号登陆鉴权功能。
js-sdk | Flutter | .NET | 小程序端 | node-sdk | php | wx-server-sdk |
---|---|---|---|---|---|---|
app.analytics/广告数据上报 | wx.cloud.callContainer/云托管 | app.analytics/广告数据上报 | CloudPay/微信支付 | |||
cloudbase.useAdapters/引入适配器 | Cloud.CloudID(cloudID: string)/获取开放数据 | app.logger().log(logMsg)/日志上报 | Cloud.getWXContext()在云函数中获取微信调用上下文 | |||
Cloud.CDN小程序端调云函数传递大数据可用的临时 CDN | tcb.parseContext(context)/解析云函数环境变量 | Cloud.logger()云函数中使用高级日志能力 | ||||
tcb.getCloudbaseContext(context)/获取云函数环境变量 | Cloud.getCloudCallSign获取签名 | |||||
Cloud.getOpenData/获取 CloudID 对应的开放数据 | ||||||
Cloud.getVoIPSign/获取实时语音签名 | ||||||
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。