wilddog for javascriptAPI文档

《wilddog for javascriptAPI文档》由会员分享，可在线阅读，更多相关《wilddog for javascriptAPI文档（82页珍藏版）》请在装配图网上搜索。

1、API文档上次更改时间 2015/12/08 Wilddog (Methods)o new Wilddog()o authWithCustomToken()o authAnonymously()o authWithPassword()o authWithOAuthPopup()o authWithOAuthRedirect()o authWithOAuthToken()o getAuth()o onAuth()o offAuth()o unauth()o child()o parent()o root()o key()o toString()o set()o update()o remove(

2、)o push()o setWithPriority()o setPriority()o transaction()o createUser()o changePassword()o changeEmail()o removeUser()o resetPassword()o goOnline()o goOffline() Query (Methods)o on()o off()o once()o orderByChild()o orderByKey()o orderByValue()o orderByPriority()o startAt()o endAt()o equalTo()o limi

3、tToFirst()o limitToLast()o ref() Wilddog.onDisconnect (Methods)o set()o update()o remove()o setWithPriority()o cancel() Wilddog.ServerValue (Constants)o TIMESTAMP DataSnapshot (Methods)o exists()o val()o child()o forEach()o hasChild()o hasChildren()o key()o numChildren()o ref()o getPriority()o expor

4、tVal()RWilddog (Methods)new Wilddog()定义new Wilddog ( wilddogUrl )说明初始化一个Wilddog客户端。参数 wilddogUrlstring应用url 如：https:/返回值 Wilddog 对象的引用示例ref = new Wilddog(https:/Good, 我们已经创建了一个野狗客户端。authWithCustomToken()定义authWithCustomToken ( token , oncomplete )说明使用一个认证的token或超级密钥进行登录。 tokenstringtoken 可以是一个Wilddo

5、g 超级密钥，或由密钥生成的token。 oncompletefunction(err,auth)如果操作成功err为null,auth为包含用户登录认证信息的对象；如果不成功err是一个包含code的对象，auth为null。示例var ref = new Wilddog(https:/);ref.authWithCustomToken(AUTH_TOKEN, function(error, authData) if (error) console.log(Login Failed!, error); else console.log(Authenticated successfully w

6、ith payload:, authData); );authAnonymously()定义authAnonymously ( oncomplete )说明匿名登录你的应用参数 oncompletefunction(err,auth)如果操作成功err为null,auth为包含用户登录认证信息的对象；如果不成功err是一个包含code的对象，auth为null。示例var ref = new Wilddog(https:/);ref.authAnonymously( function(err,data) if(err = null) console.log(auth success!); el

7、se console.log(auth failed,msg:,err); );authWithPassword()定义authWithPassword ( credentials , oncomplete )说明通过邮箱密码登录你的应用。使用此函数前，必须进入终端用户认证页面，开启野狗默认用户数据库。参数 credentialsobject包含用户认证信息的数据,包括emailpassword(eg.email:,password:)。 oncompletefunction(err,auth)如果操作成功err为null,auth为包含用户登录认证信息的对象；如果不成功err是一个包含cod

8、e的对象，auth为null。示例var ref = new Wilddog(https:/);ref.authWithPassword(email:Loki,password:examplepassword, function(err,data) if(err = null) console.log(auth success!); else console.log(auth failed,msg:,err); );authWithOAuthPopup()定义authWithOAuthPopup ( provider , oncomplete )说明通过oauth弹框方式登录你的应用。 调用a

9、uthWithOAuthPopup,页面将弹出OAuth认证页,用户在页面进行认证操作,此过程中的任何数据都不会经过第三方 (包括Wilddog 服务),而且全部采用https 访问,因此安全可靠。当认证结束后弹框页自动关闭,用户完成登录。参数 providerstring第三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。 oncompletefunction(err,data)回调函数，认证过程结束后会被Wilddog客户端调用。如果认证失败,err参数是一个Error对象，包含错误信息；如果认证成功，err为null，data为包含认证信息的对

10、象。data中的认证信息包括以下字段：字段类型说明uidstring用户唯一IDproviderstring第三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。authobject包括token,payloadexpiresNumberOAuth过期时间,使用 unix时间戳表示示例var ref = new Wilddog(https:/);ref.authWithOAuthPopup(weixin,function(err,auth) if(err = null) console.log(auth success!); else console.

11、log(auth failed,msg:,err); )authWithOAuthRedirect()定义authWithOAuthRedirect ( provider , oncomplete )说明通过OAuth跳转方式登录你的应用。 调用authWithOAuthRedirect,页面跳转到 OAuth认证也,用户在页面进行认证操作,此过程中的任何数据都不会经过第三方 (包括Wilddog 服务),而且全部采用https 访问,因此安全可靠.当认证结束页面跳转回最初页面,认证结束。参数 providerstring第三方OAuth平台,包括weibo，weixin，weixinmp(微

12、信公众账号)，qq 等。 oncompletefunction(err,data)回调函数，认证过程结束后会被Wilddog客户端调用。如果认证失败,err参数是一个Error对象，包含错误信息；如果认证成功，err为null，data为包含认证信息的对象。data中的认证信息包括以下字段：字段类型说明uidstring用户唯一IDproviderstring第三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。authobject包括token,payloadexpiresNumberOAuth过期时间,使用 unix时间戳表示示例var ref =

13、 new Wilddog(https:/);ref.authWithOAuthPopup(weixin,function(err,auth) if(err = null) /will never be here,as the page redirect else console.log(auth failed,msg:,err) )authWithOAuthToken()定义authWithOAuthToken ( provider , accessToken , oncomplete )说明通过accessToken直接登录你的应用。 如果用户已经拿到accessToken,可以通过此接口直

14、接进行登录。参数 providerstring第三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。 accessTokenstringoauth2.0 的access token oncompletefunction(err,data)回调函数，认证过程结束后会被Wilddog客户端调用。如果认证失败,err参数是一个Error对象，包含错误信息；如果认证成功，err为null，data为包含认证信息的对象。data中的认证信息包括以下字段：字段类型说明uidstring用户唯一IDproviderstring第三方OAuth平台,包括weibo，w

15、eixin，weixinmp(微信公众账号)，qq 等。tokenstringwilddog 认证token，用来认证这个客户端authobject包括token,payloadexpiresNumberOAuth过期时间,使用 unix时间戳表示示例var ref = new Wilddog(https:/);ref.authWithOAuthToken(weixin, , function(error, authData) if (error) console.log(Login Failed!, error); else console.log(Authenticated success

16、fully with payload:, authData); );getAuth()定义getAuth()说明同步返回当前Auth状态返回值如果当前用户已经认证，返回一个对象，这个对象包含如下字段：字段类型说明uidstring用户唯一IDproviderstring第三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。tokenstringwilddog 认证token，用来认证这个客户端authobject包括token,payloadexpiresNumberOAuth过期时间,使用 unix时间戳表示示例var ref = new Wildd

17、og(https:/);var authData = ref.getAuth();if (authData) console.log(Authenticated user with uid:, authData.uid);onAuth()定义onAuth ( onComplete , context )说明监听客户端登录状态的变化。参数 onCompletefunction(auth)回调函数，onAuth被调用时触发一次，之后每次状态发生改变都触发一次。如果当前客户端已经认证，auth为包含认证信息的对象，包含如下字段：字段类型说明uidstring用户唯一IDproviderstring第

18、三方OAuth平台,包括weibo，weixin，weixinmp(微信公众账号)，qq 等。tokenstringwilddog 认证token，用来认证这个客户端authobject包括token,payloadexpiresNumberOAuth过期时间,使用 unix时间戳表示 contextobject如果指定，你的回调函数中的this将代表这个对象示例var ref = new Wilddog(https:/);ref.onAuth(function(authData) if (authData) console.log(Authenticated with uid:, authD

19、ata.uid); else console.log(Client unauthenticated.); );offAuth()定义offAuth ( onComplete , context )说明取消对客户端认证状态变化的监听，是onAuth的逆操作。参数 onCompletefunction(auth)调用onAuth时传入的函数。 contextObject调用onAuth时传入的对象示例var onAuthCallback = function(authData) if (authData) console.log(Authenticated with uid:, authData.

20、uid); else console.log(Client unauthenticated.); ;/ Attach the callbackref.onAuth(onAuthCallback);/ Sometime later./ Detach the callbackref.offAuth(onAuthCallback);unauth()定义unauth()说明注销登录示例var ref = new Wilddog(https:/);/ Sometime later./ Unauthenticate the clientref.unauth();child()定义child ( path

21、)说明根据相对路径，来获取当前节点下子节点的引用参数 pathStringpath为相对路径，多层级间需要使用/分隔，例如“a/b”。如果path为空或null则返回当前引用。如果直接选取下一级节点，可以使用无分隔符(/)的节点名称表示，例如“a”。如果定位的path不存在，依然可以定位，后续数据操作的时候，将延迟动态创建不存在的路径节点。返回值 Wilddog子节点的引用。var ref = new Wilddog(https:/ref refer to node child_ref = ref.child(Beijing);/now child_ref refer to parent()定

22、义parent()说明获取父节点的引用。如果当前节点就是root节点，函数执行后返回的依然是root节点的引用。返回值 StringWilddog 父节点的引用示例var parent_ref = ref.parent();/返回值 the refer to the father node of currentroot()定义root()说明获得wilddog根结点的引用返回值 Stringwilddog根节点的引用示例var ref = new Wilddog(https:/ref refer to node root_ref = ref.root(Beijing);/now child_r

23、ef refer to key()定义key()说明获得当前路径下节点的名称。返回值 String节点名称示例var ref = new Wilddog(https:/返回值 the key to current nodevar key = ref.key();/key is BejingtoString()定义toString()说明获取当前节点的应用URL。返回值 String当前节点的应用URL。示例var ref = new Wilddog(https:/返回值 the key to current nodevar url = ref.toString();/url should be

24、 https:/set()定义set ( value , oncomplete )说明设置一个节点的值。 如果value != null,当前节点上的数据会被value覆盖，如果中间路径不存在,Wilddog 会自动将中间路径补全。如果value = null,效果等同于remove操作。参数 valueobject|string|number|boolean|null将被写入的值。 onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码code的对象。示例var ref = new Wilddog(https:/the initial value

25、 is temp:23,humidity:30,wind:2ref.set(temp:10,pm25:500);/the expected value of https:/ should be temp:10,pm25:500update()定义update ( value , onComplete )说明将输入对象的子节点合并到当前数据中。不存在的子节点将会被新增，存在子节点将会被替换。 与set操作不同,update不会直接覆盖原来的节点,而是将value中的所有子节点插入到已有的节点中,如果已有的节点中已经有同名子节点,则覆盖原有的子节点 e.g. update之前l1:on,l3:of

26、f,value=l1:off,l2:onupdate 后期望的数据是l1:off,l2:on,l3:off。参数 valueobject包含要合并子节点的对象 onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码code的对象。示例var ref = new Wilddog(https:/the initial value is temp:23,humidity:30,wind:2ref.update(temp:10,pm25:500);/the expected value of https:/ should be temp:10,pm25:5

27、00,humidity:30,wind:2remove()定义remove ( onComplete )说明删除当前节点,效果等同于set(null,onComplete), 如果父级节点只有当前节点一个子节点, 会递归删除父级节点。参数 onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码code的对象。示例/the initial value of https:/ is /city:Beijing:temp:23,humidity:30,wind:2var ref = new Wilddog(https:/ref.remove()/ valu

28、e of https:/ is push()定义push (value , oncomplete )说明在当前节点下生成一个子节点，并返回子节点的引用。子节点的key利用服务端的当前时间生成，可作为排序使用。参数 valueobject|string|number|boolean|null用户希望在当前节点下新增的数据. onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码code的对象。返回值 String新插入子节点的引用示例var ref = new Wilddog(https:/var childref = ref.push(name:T

29、hor,planet:Asgard);var newKey = childref.key();/newKey shoud look like a base64-like series eg -JmRhjbYk73IFRZ7/th url of newKey shoud be https:/setWithPriority()定义setWithPriority ( value , priority , oncomplete )说明把数据写到当前位置，类似set,不同之处是需要指定一个优先级。默认排序按照优先级排序。(参考setPriority)参数 valueObject|String|Numbe

30、r|Boolean|Null将被写入的值。 priorityString|Number优先级数据，节点的优先级是默认排序的依据。 onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码code的对象。示例var ref = new Wilddog(https:/var user = name: first: jack, last: Lee ;ref.setWithPriority(user,100);setPriority()定义setPriority ( priority , onComplete )说明设置当前节点的优先级，优先级可以是Numb

31、er,也可以是String。用来改当前节点在兄弟节点中的排序位置。这个排序会影响Snapshot.forEach()的顺序，同样也会影响child_added事件中prevChildName参数。节点按照如下规则排序 没有priority的排最先 有数字 priority的次之，按照数值排序 有字符串 priority的排最后，按照字母表的顺序排列 当两个子节点有相同的 priority，它们按照名字进行排列，数字排在最先，字符串排最后参数 priorityString|Number优先级 onCompletefunction(err)如果操作成功err为null；否则,err为包含错误码co

32、de的对象。示例var ref = new Wilddog(https:/ref.setPriority(1000);transaction()定义transaction(updateFunction, onComplete, applyLocally)说明在当前路径下，自动修改数据。与 set() 不同，直接覆盖以前的数据，transaction() 能够确保不同客户端在相同时间没有修改冲突。为了到达目的， 你通过 transaction() 的更新函数将的作用是把 current value 转换成 new value。当另外一个客户端在你之前先成功，你的更新函数将重新调用并带有 new

33、current value。这过程一直重复直到写入成功或者不返回 value 来中止事务。如果需要， 你的 onComplete callback 将在事务完成后异步被调用。注意：在相同的路径上 使用 set() 和 transaction() , 极端情况下将出现不可预料的结果。参数 updateFunctionfunction更新数据的函数 onCompletefunction(error, committed, snapshot)如果操作成功err为null；否则,err为包含错误码code的对象。 committedboolean提交成功。 snapshotDataSnapShot事务

34、完成后的数据快照。示例var ref = new Wilddog(https:/ref.transaction(function(currentRank) / If /users/fred/rank 没有设置数据，currentRank 将会是 null 。 return currentRank+1;);/ 试图创建 wilma 的用户， 如果你的用户 wilma 已经存在，那退出事务var wilmaRef = new Wilddog(https:/wilmaRef.transaction(function(currentData) if (currentData = null) retur

35、n name: first: Wilma, last: Flintstone ; else console.log(用户 wilma 已经存在。); return; / 退出事务 , function(error, committed, snapshot) if (error) console.log(Transaction 失败了!, error); else if (!committed) console.log(我们退出事务，因为用户wilma 已经存在。); else console.log(用户 wilma 已经添加!); console.log(Wilmas data: , sna

36、pshot.val(););createUser()定义createUser ( credentials , onComplete )说明通过邮箱密码创建你的终端用户。使用此函数前，必须进入终端用户认证页面，开启野狗默认用户数据库。 通过createUser注册的终端用户会托管在Wilddog平台, 被注册的用户可以采用authWithPassword登录认证。参数 credentialsobject包含用户认证信息的数据,包括emailpassword(eg.email:,password:)。 onCompletefunction(err,data)如果操作成功err为null,data为

37、包含用id,provider的对象；如果不成功err是一个包含code的对象。示例ref.createUser(email:Loki,password:examplepassword, function(err,data) if(err!=null) /not success else /create user success );changePassword()定义changePassword ( credentials , onComplete )说明修改终端用户密码 Wilddog 平台托管的终端用户可以通过changePassword修改密码参数 credentialsobject需要

38、包含email邮箱oldPassword旧密码newPassword新密码 onCompletefunction(err,data)如果操作成功err为null,data为包含id,provider的对象；如果不成功err是一个包含错误码code的对象。changeEmail()定义changeEmail ( credentials , onComplete )说明修改终端用户登录邮箱。Wilddog平台托管的终端用户可以通过changeEmail修改登录邮箱。参数 credentialsobject需要包含oldEmail旧邮箱newEmail新邮箱password密码 onComplete

39、function(err)回调函数,操作成功后会被调用,如果操作成功err为null,如果操作失败,err是一个包含错误码code的对象removeUser()定义removeUser ( credentials , onComplete )说明删除终端用户的帐号Wilddog平台托管的终端用户可以通过removeUser删除帐号参数 credentialsobject包含email，password字段的对象。 onCompletefucntion(err)回调函数,操作成功后会被调用,如果操作成功err为null,如果操作失败,err是一个包含错误码code的对象resetPassword

40、()定义resetPassword ( credentials , onComplete )说明重置终端用户的密码。 接口调用成功后并不会立刻重置密码,而是发一封邮件到此邮箱,终端用户通过该邮件的引导可完成重置密码操作。 Wilddog 平台托管的终端用户可以通过resetPassword重置密码。参数 credentialsobject包含email字段的对象 onCompletefunction(err)回调函数,操作成功后会被调用,如果操作成功err为null,如果操作失败,err是一个包含错误码code的对象goOnline()定义Wilddog.goOnline()说明手动建立连接，

41、开启自动重连。示例var ref = new Wilddog(https:/Wilddog.goOffline(); / All local Wilddog instances are disconnectedWilddog.goOnline(); / All local Wildodg instances automatically reconnectgoOffline()定义Wilddog.goOffline()说明手动断开连接，关闭自动重连。示例var ref = new Wilddog(https:/Wilddog.goOffline(); / All local Wilddog in

42、stances are disconnectedQuery (Methods)on()定义on ( type , callback , cancelCallback ， context )说明监听某个事件,注册回调函数。参数 typeString事件说明value当有数据请求或有任何数据发生变化时触发child_added当有新增子节点时触发child_changed当某个子节点发生变化时触发child_removed当有子节点被删除时触发 callbackfunction(snapshot,prev)snapshot为Snapshot类型,当监听到某事件时callback 会被执行. 在ch

43、ild_* 事件中会有prev参数。表示当前节点的上一个节点的key cancelCallbackfunction(err)如果操作失败，这个函数会被调用。传入一个Error对象，包含为何失败的信息。 contextObject如果指定，你的回调函数中的this将代表这个对象示例ref.on(child_added,function(snapshot,prev) console.log(snapshot.val(); console.log(the previous key is,prev);off()定义off ( type , callback , context )说明取消监听事件。取消

44、之前用on()注册的回调函数。参数 typeStringvalue,child_added,child_changed,child_removed之一 callbackfunction(snapshot)on()中被传入的函数 contextObjecton()中被传入的context示例var onValueChange = function(dataSnapshot) /* handle. */ ;wilddogRef.on(value, onValueChange);/ Sometime later.wilddogRef.off(value, onValueChange);var onV

45、alueChange = wilddogRef.on(value, function(dataSnapshot) /* handle. */ );/ Sometime later.wilddogRef.off(value, onValueChange);once()定义once ( type , callback , cancelCallbak , context )说明同on 类似,不同之处在于 once中的回调函数只被执行一次。参数 typeString事件说明value当有数据请求或有任何数据发生变化时触发child_added当有新增子节点时触发child_changed当某个子节点发

46、生变化时触发child_removed当有子节点被删除时触发 callbackfunction(snapshot)snapshot为Snapshot类型,当监听到某事件时callback 会被执行. cancelCallbackfunction(err)如果操作失败，这个函数会被调用。传入一个Error对象，包含为何失败的信息。 contextObject如果指定，你的回调函数中的this将代表这个对象示例ref.once(child_added,function(snapshot) console.log(snapshot.val(););orderByChild()定义orderByChi

47、ld ( key )说明产生一个新Query对象，按照特定子节点的值进行排序。排序的详情请参考数据排序。参数 keyString指定用来排序的子节点的key返回值 新生成的Query对象的引用示例var ref = new Wilddog(https:/ref.orderByChild(height).on(child_added,function(snapshot) console.log(snapshot.key() + is + snapshot.val().height +meters tall););orderByKey()定义orderByKey()说明产生一个新Query对象，按

48、照当前节点的key进行排序。排序的详情请参考数据排序。返回值 新生成的Query对象的引用示例var ref = new Wilddog(https:/ref.orderByKey().on(child_added,function(snapshot) console.log(snapshot.key(););orderByValue()定义orderByValue()说明产生一个新Query对象，按照当前节点的值进行排序。排序的详情请参考数据排序。返回值 新生成的Query对象的引用示例var scoresRef = new Wilddog(https:/scoresRef.orderByV

49、alue().limitToLast(3).on(value, function(snapshot) snapshot.forEach(function(data) console.log(The + data.key() + score is + data.val(); );orderByPriority()定义orderByPriority()说明产生一个新Query对象，按照当前节点的优先级排序。排序的详情请参考数据排序。返回值 新生成的Query对象的引用。示例var ref = new Wilddog(https:/ref.orderByPriority().on(child_add

50、ed, function(snapshot) console.log(snapshot.key(););startAt()定义startAt ( value , key )说明创建一个大于等于的范围查询，可配合orderBy方式使用。详情请参考复杂查询参数 valueString|Number|Null|Boolean查询的起始值，类型取决于这个查询用到的orderBy*()函数。如果与orderByKey()组合的话，value一定是一个String。 keyString起始子节点的key，只有在orderByPriority()时有效。返回值新生成的Query对象的引用。示例var ref

51、 = new Wilddog(https:/ref.orderByKey().startAt(jack).on(child_added,function(snapshot) console.log(snapshot.key(););endAt()定义endAt ( value , key )说明创建一个小于等于的范围查询，可配合orderBy方式使用。详情请参考复杂查询参数 valueString|Number|Null|Boolean查询的结束值，类型取决于这个查询用到的orderBy*()函数。如果与orderByKey()组合的话，value一定时一个String。 keyString起

52、始子节点的key，只有在orderByPriority()时有效。返回值新生成的Query对象示例var ref = new Wilddog(https:/ref.orderByKey().endAt(jack).on(child_added,function(snapshot) console.log(snapshot.key(););equalTo()定义equalTo ( value , key )说明创建一个等于的精确查询。详情请参考复杂查询参数 valueString|Number|Null|Boolean需要匹配的数值，类型取决于这个查询用到的orderBy*()函数。如果与orderByKey()组合的话，value一定是一个String。 keyString起始子节点的key，只有在orderByPriority()时有效。