GizAepHomeManager 家庭管理类
提供家庭、房间、联系人、分组、家庭成员的增删改查接口
目录
API 定义
[sharedInstance]
获取GizAepHomeManager单例的实例
定义
public static synchronized GizAepHomeManager sharedInstance();
代码示例
GizAepHomeManager mSDKInstance = GizAepHomeManager.sharedInstance();
[getHomeList]
获取家庭列表
定义
public void getHomeList(RequestListener<AepResult<List<GizAepApiHome>>> requestListener);
参数
属性名 |
描述 |
requestListener |
获取家庭列表回调 |
回调参数
属性名 |
描述 |
result |
AepResult>类型,详细见AepResult和GizAepApiHome定义 |
代码示例
Log.d("Hello world!");
[createHome]
创建家庭
定义
public void createHome(GizAepApiHome home, RequestListener<AepResult<GizAepApiHome>> requestListener);
参数
属性名 |
描述 |
home |
家庭对象 |
requestListener |
请求结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult和GizAepApiHome定义 |
代码示例
Log.d("Hello world!");
[deleteHome]
删除家庭
定义
public void deleteHome(String homeId, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
requestListener |
删除家庭回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[editHome]
编辑家庭
定义
public void editHome(GizAepApiHome home, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
home |
家庭对象 |
requestListener |
编辑家庭结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
创建联系人
定义
public void createContact(GizAepContact gizAepContact, RequestListener<AepResult<GizAepContact>> requestListener);
参数
属性名 |
描述 |
gizAepContact |
联系人对象 |
requestListener |
创建联系人结果 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult和GizAepContact定义 |
代码示例
Log.d("Hello world!");
删除联系人
定义
public void deleteContact(List<String> contactIds, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
contactIds |
联系人id数组 |
requestListener |
删除联系人结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
编辑联系人
定义
public void editContact(GizAepContact contact, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
contact |
联系人对象 |
requestListener |
编辑联系人回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
获取联系人列表
定义
public void getContactList(String homeId, RequestListener<AepResult<List<GizAepContact>>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
requestListener |
获取联系人列表回调 |
回调参数
属性名 |
描述 |
result |
AepResult>类型,详细见AepResult和GizAepContact定义 |
代码示例
Log.d("Hello world!");
[getMemberList]
获取成员列表
定义
public void getMemberList(String homeId, RequestListener<AepResult<List<GizHomeMember>>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
requestListener |
获取成员列表结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult>类型,详细见AepResult和GizHomeMember定义 |
代码示例
Log.d("Hello world!");
修改家庭成员备注
定义
public void remarkMember(GizHomeMember gizHomeMember, String homeId, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
gizHomeMember |
编辑的房间对象 |
homeId |
家庭id |
callback |
编辑结果,可获取信息查看AepApiResult |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[deleteMember]
删除家庭成员
定义
public void deleteMember(String memberId, String homeId, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
memberId |
家庭成员ID |
homeId |
家庭id |
requestListener |
删除家庭成员回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[getHomeShareToken]
生成家庭分享token,建议按二维码展示
定义
public void getHomeShareToken(String homeId, int minutes, int times, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
minutes |
分享token时间,单位为分钟,默认60 |
times |
分享token可被使用次数,默认1次 |
requestListener |
生成二维码结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[checkHome]
检查分享token有效性,用于自动刷新检测
定义
public void checkHome(String homeId,String token, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
token |
家庭分享token |
requestListener |
检查结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[acceptHomeShareToken]
接受家庭分享,用户接受另一个用户家庭分享token可以加入另一个用户的家庭,变成成员
定义
public void acceptHomeShareToken(String token, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
token |
接受的家庭分享token |
requestListener |
接受分享结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[quitHome]
退出家庭
定义
public void quitHome(String homeId, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
requestListener |
退出家庭结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[createRoom]
创建房间
定义
public void createRoom(GizAepApiRoom room, String homeId, RequestListener<AepResult<GizAepApiRoom>> requestListener);
参数
属性名 |
描述 |
room |
房间对象 |
homeId |
家庭id |
requestListener |
创建房间结果 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult和GizAepApiRoom定义 |
代码示例
Log.d("Hello world!");
[deleteRoom]
删除房间
定义
public void deleteRoom(String roomId, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
roomId |
房间号ID |
requestListener |
删除房间结果回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[editRoom]
编辑房间
定义
public void editRoom(GizAepApiRoom room, RequestListener<AepResult<String>> requestListener);
参数
属性名 |
描述 |
room |
编辑的房间对象 |
requestListener |
编辑房间结果 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult定义 |
代码示例
Log.d("Hello world!");
[getRoomList]
获取房间列表
定义
public void getRoomList(String homeId, RequestListener<AepResult<List<GizAepApiHome>>> requestListener);
参数
属性名 |
描述 |
homeId |
家庭id |
requestListener |
获取房间列表结果 |
回调参数
属性名 |
描述 |
result |
AepResult>类型,详细见AepResult和GizAepApiHome定义 |
代码示例
Log.d("Hello world!");
[createGroup]
创建分组
定义
public void createGroup(GizAepGroup gizAepGroup, String roomId, RequestListener<AepResult<GizAepGroup>> requestListener);
参数
属性名 |
描述 |
gizAepGroup |
分组对象 |
roomId |
分组所在房间id |
requestListener |
创建分组回调 |
回调参数
属性名 |
描述 |
result |
AepResult类型,详细见AepResult和GizAepGroup定义 |
代码示例
Log.d("Hello world!");