wilddog for javascriptAPI文档.doc

API文档 上次更改时间 2015/12/08 Wilddog (Methods) new Wilddog() authWithCustomToken() authAnonymously() authWithPassword() authWithOAuthPopup() authWithOAuthRedirect() authWithOAuthToken() getAuth() onAuth() offAuth() unauth() child() parent() root() key() toString() set() update() remove() push() setWithPriority() setPriority() transaction() createUser() changePassword() changeEmail() removeUser() resetPassword() goOnline() goOffline() Query (Methods) on() off() once() orderByChild() orderByKey() orderByValue() orderByPriority() startAt() endAt() equalTo() limitToFirst() limitToLast() ref() Wilddog.onDisconnect (Methods) set() update() remove() setWithPriority() cancel() Wilddog.ServerValue (Constants) TIMESTAMP DataSnapshot (Methods) exists() val() child() forEach() hasChild() hasChildren() key() numChildren() ref() getPriority() exportVal() R Wilddog (Methods) new Wilddog() 定义 new Wilddog ( wilddogUrl ) 说明 初始化一个Wilddog客户端。 参数 wilddogUrl?string?应用url 如：https://appId. 返回值 Wilddog 对象的引用 示例 ref = new Wilddog(https://appId./city/Beijing); //Good, 我们已经创建了一个野狗客户端。 authWithCustomToken() 定义 authWithCustomToken ( token , oncomplete ) 说明 使用一个认证的token或超级密钥进行登录。 token?string?token 可以是一个Wilddog 超级密钥，或由密钥生成的token。 oncomplete?function(err,auth)?如果操作成功err?为null,auth为包含用户登录认证信息的对象；如果不成功?err?是一个包含?code?的对象，auth?为?null。 示例 var ref = new Wilddog(https://appId.); ref.authWithCustomToken(AUTH_TOKEN, function(error, authData) { if (error) { console.log(Login Failed!, error); } else { console.log(Authenticated successfully with payload:, authData); } }); authAnonymously() 定义 authAnonymously ( oncomplete ) 说明 匿名登录你的应用 参数 oncomplete?function(err,auth)?如果操作成功err?为null,auth为包含用户登录认证信息的对象；如果不成功?err?是一个包含?code?的对象，auth?为?null。 示例 var ref = new Wilddog(https://appId.); ref.authAnonymously( function(err,data){ if(err == null){ console.log(auth success!); } else { console.log(auth failed,msg:,err); } } ); authWithPassword(