ChildEventListener 编辑文档

Wilddog Sync 数据监听器,主要用于监听当前节点下子节点的变化,当子节点数据发生变化时将触发相应的回调方法。


注意:


此监听器只关注当前节点的子节点,适用与关注子节点变化的场景。

方法

onChildAdded(snapshot, previousChildName)

定义
void onChildAdded(DataSnapshot snapshot, String previousChildName)
说明

当有新增子节点时触发此方法。
如果当前节点存在历史数据,设置数据监听时,会按当前排序逐条返回当前节点下所有子节点的数据快照。

参数
参数名 说明
snapshot DataSnapshot 子节点数据快照。
previousChildName String 按照当前排序前一节点的 key 值。如果当前节点为第一个子节点,该值为 null。



onChildChanged(snapshot, previousChildName)

定义
void onChildChanged(DataSnapshot snapshot, String previousChildName)
说明

当前节点的子节点发生改变的时候触发此方法。
在子节点下增加数据将会触发 onChildChanged 事件,而不会触发 onChildAdded 事件。

参数
参数名 说明
snapshot DataSnapshot 变化后的子节点数据快照。
previousChildName String 按照当前排序前一节点的 key 值。如果当前节点为第一个子节点,该值为 null。



onChildMoved(snapshot, previousChildName)

定义
void onChildMoved(DataSnapshot snapshot, String previousChildName)
说明

当前排序下,某子节点排序发生变化时触发此方法。
例如当按照优先级排序时,某个子节点的优先级发生改变时将返回此节点数据快照,以及按照新优先级值排序后的前一节点 key 值。

参数
参数名 说明
snapshot DataSnapshot 排序发生变化的子节点数据快照。
previousChildName String 按照当前排序前一节点的 key 值。如果当前节点为第一个子节点,该值为 null。
示例
//当前数据
//DataSnapshot { key = orderByPriorityTest,
//value = {aaa={.priority=0.0, .value=aaa}, bbb={.priority=1.0, .value=bbb},
//ccc={.priority=2.0, .value=ccc}, ddd={.priority=3.0, .value=ddd}, eee={.priority=4.0, .value=eee} }
//当前排序为 aaa -> bbb -> ccc -> ddd -> eee
ref.child("orderByPriorityTest").child("ccc").setPriority(4.1);
//更新优先级后排序为 aaa -> bbb -> ddd -> eee -> ccc
//在 'onChildMoved' 方法中返回数据
//DataSnapshot { key = ccc, value = {.priority=4.1, .value=ccc} }, prevNode:eee



onChildRemoved(snapshot)

定义
void onChildRemoved(DataSnapshot snapshot)
说明

移除子节点时触发这个方法。

参数
参数名 说明
snapshot DataSnapshot 被移除的子节点数据快照。



onCancelled(error)

定义
void onCancelled(SyncError error)
说明

当客户端失去对该节点的读取权限时会触发此方法。导致失去读取权限的原因包括:规则表达式限制,数据限制,套餐超出限制等。

参数
参数名 说明
error SyncError 错误详细描述。


野狗新手?
立即注册,为你提供安全可靠的实时通信云服务。
没找到需要的文档?
你可以提交工单反馈 或 阅读常见问题
期待收到你的反馈,帮助我们改进文档。
参与调研