ZEPETO.Module.Social
30 分
类型 说明 socialservice /#socialservice socialservice 用于实现 zepeto world 内的社交功能。 该服务使玩家能够访问社交数据,例如用户的关注关系。 同时提供向其他玩家发送私信的功能。 roommemberstatus /#roommemberstatus 表示与本地玩家关系的枚举。 myfollowerlistresponse /#myfollowerlistresponse myfollowerlistresponse 类提供本地玩家的粉丝列表信息。 myfollowinglistresponse /#myfollowinglistresponse myfollowinglistresponse 类提供 api 调用结果以及本地玩家的关注列表信息。 userfollowinfolistresponse /#userfollowinfolistresponse userfollowinfolistresponse 类提供 api 调用结果以及多个用户的关注信息列表。 userfollowinforesponse /#userfollowinforesponse userfollowinforesponse 类提供 api 调用结果以及该用户的关注信息列表。 userfollowstatusresponse /#userfollowstatusresponse userfollowstatusresponse 类提供 api 调用结果,以及表示指定用户是否与本地玩家存在关注关系的信息。 directmessagepopupstate /#directmessagepopupstate 枚举私信弹窗的状态。 userinfo /#userinfo 用户信息。 userfollowinfo /#userfollowinfo 用户的关注信息。 useraccounttype /#useraccounttype 表示用户账号类型的枚举。 followstatus /#followstatus 表示与本地玩家的关注关系。 followcellview /#followcellview 用于官方好友列表弹窗的类。 userinfocellview /#userinfocellview 用于在官方好友列表弹窗中显示好友信息的 ui 元素类。 totalcountcellview /#totalcountcellview 用于在官方好友列表弹窗中显示好友总数的类。 socialservice class socialservice 用于实现 zepeto world 内的社交功能。 该服务使玩家能够访问社交数据,例如用户的关注关系。 同时提供向其他玩家发送私信的功能。 方法 add onroommemberstatuschanged static add onroommemberstatuschanged(value action\<string, roommemberstatus>) → void 该异步方法用于获取本地玩家的粉丝列表。 参数 类型 value action\<string, roommemberstatus> getmyfollowinglistasync static getmyfollowinglistasync(nextpagetoken? string) → baserequest\<myfollowinglistresponse> 该异步方法用于获取本地玩家的关注列表。 参数 类型 说明 nextpagetoken (可选) string 分页令牌。首次调用该方法时,请将该参数设置为 null 。 返回值: baserequest\<myfollowinglistresponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 myfollowinglistresponse 对象。 getuserfollowinfoasync static getuserfollowinfoasync(userids string\[]) → baserequest\<userfollowinfolistresponse> 该异步方法用于获取多个用户的关注信息。 参数 类型 说明 userids string\[] 需要查询关注列表的多个用户 id。 返回值: baserequest\<userfollowinfolistresponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 userfollowinfolistresponse 对象。 getuserfollowinfoasync static getuserfollowinfoasync(userid string) → baserequest\<userfollowinforesponse> 该异步方法用于获取单个用户的关注信息。 参数 类型 说明 userid string 需要查询关注列表的用户 id。 返回值: baserequest\<userfollowinforesponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 userfollowinforesponse 对象。 getuserfollowstatusasync static getuserfollowstatusasync(userid string) → baserequest\<userfollowstatusresponse> 该异步方法用于获取本地玩家与某个用户之间的关注关系信息。 参数 类型 说明 userid string 需要查询关注状态的用户 id。 返回值: baserequest\<userfollowstatusresponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 userfollowstatusresponse 对象。 openpopupdirectmessage static openpopupdirectmessage(sendmessage string, userids? string\[], oncomplete? action\<directmessagepopupstate>) → void 弹出用于向用户发送私信的弹窗。 参数 类型 说明 sendmessage string 要发送的消息正文。若为空白或为空,则发送将失败。 userids (可选) string\[] 潜在收件人的用户 id 列表。若省略 users 参数,收件人选择界面将自动填入发送者的粉丝/关注列表中的用户。 oncomplete (可选) action\<directmessagepopupstate> 消息发送完成或取消时调用的回调函数。 roommemberstatus enum 表示与本地玩家关系的枚举。 名称 值 说明 none 0 表示本地玩家是否未关注该用户。 following 1 表示本地玩家是否已关注该用户。 blocked 3 表示本地玩家是否已屏蔽该用户。 myfollowerlistresponse class · extends playbaasresponse myfollowerlistresponse 类提供本地玩家的粉丝列表信息。 属性 名称 类型 说明 usercount number 关注本地玩家的用户数量。 users userinfo\[] /#userinfo 关注本地玩家的用户信息。 nextpagetoken string 当可用条目较多时,响应中会包含 nextpagetoken ,可用于获取后续的粉丝列表。当没有剩余条目时, nextpagetoken 为 null。 myfollowinglistresponse class · extends playbaasresponse myfollowinglistresponse 类提供 api 调用结果以及本地玩家的关注列表信息。 属性 名称 类型 说明 usercount number 本地玩家关注的用户数量。 users userinfo\[] /#userinfo 本地玩家关注的用户信息。 bookmarkusers userinfo\[] /#userinfo 本地玩家收藏的用户信息。 nextpagetoken string 当可用条目较多时,响应中会包含 nextpagetoken ,可用于获取后续的关注列表。当没有剩余条目时, nextpagetoken 为 null。 userfollowinfolistresponse class · extends baseresponse userfollowinfolistresponse 类提供 api 调用结果以及多个用户的关注信息列表。 属性 名称 类型 说明 users userfollowinfo\[] /#userfollowinfo 多个用户的关注信息列表数组。 userfollowinforesponse class · extends baseresponse userfollowinforesponse 类提供 api 调用结果以及该用户的关注信息列表。 属性 名称 类型 说明 user userfollowinfo /#userfollowinfo 该用户的关注信息列表数组。 userfollowstatusresponse class · extends playbaasresponse userfollowstatusresponse 类提供 api 调用结果,以及表示指定用户是否与本地玩家存在关注关系的信息。 属性 名称 类型 说明 status followstatus /#followstatus 指定用户与本地玩家的关注关系。 directmessagepopupstate enum 枚举私信弹窗的状态。 名称 值 说明 cancel 0 手动关闭弹窗或发送失败时。 sendcomplete 1 发送请求完成并关闭弹窗时。 userinfo class 用户信息。 属性 名称 类型 说明 zepetoid string 用户的唯一句柄,通常以 @ 符号呈现。 userid string 内部用户标识符。 name string 用户的显示名称。 isofficialaccount boolean 表示该账号是否为官方账号。 accounttype useraccounttype /#useraccounttype 用户账号类型。 followstatus followstatus /#followstatus 与本地玩家的关注关系。 方法 getprofilethumbnailasync getprofilethumbnailasync() → baserequest\<textureresponse> 该异步方法用于获取用户资料的缩略图。 返回值: baserequest\<textureresponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 textureresponse 对象。 getbadgeimageasync getbadgeimageasync() → baserequest\<textureresponse> 若该用户为 greeter 或 creator 账号,该异步方法用于从其个人资料中获取徽章图片。 返回值: baserequest\<textureresponse> — 一个 baserequest 对象。异步处理完成后,可通过 responsedata 属性访问 textureresponse 对象。 userfollowinfo class · extends userinfo /#userinfo 用户的关注信息。 属性 名称 类型 说明 followingcount number 该账号关注的用户数量。 followercount number 该账号的粉丝数量。 useraccounttype enum 表示用户账号类型的枚举。 名称 值 说明 default 0 普通用户。 greeter 1 为 greeter 计划指定的账号,用于协助新用户。 followstatus class 表示与本地玩家的关注关系。 属性 名称 类型 说明 isfollower boolean 表示该用户是否为本地玩家的粉丝。 isfollowing boolean 表示本地玩家是否已关注该用户。 followcellview class · extends enhancedscrollercellview 用于官方好友列表弹窗的类。 属性 名称 类型 说明 textfollowbutton string 返回官方好友列表弹窗中关注按钮上显示的本地化文本标签。该文本会自动翻译为与设备设置相匹配的语言。 textfollowingbutton string 返回官方好友列表弹窗中已关注按钮上显示的本地化文本标签。该文本会自动翻译为与设备设置相匹配的语言。 cellheight number 返回用户信息单元格视图的高度。 事件 名称 类型 说明 oncreated unityevent 返回官方好友列表弹窗创建时调用的事件。 ondeactivated unityevent 返回官方好友列表弹窗停用时调用的事件。 onactivated unityevent 返回官方好友列表弹窗激活时调用的事件。 userinfocellview class · extends followcellview /#followcellview 用于在官方好友列表弹窗中显示好友信息的 ui 元素类。 属性 名称 类型 说明 userinfo userinfo /#userinfo 返回在 ui 上显示的用户信息。 textname string 返回在 ui 上显示的账号用户名。 totalcountcellview class · extends followcellview /#followcellview 用于在官方好友列表弹窗中显示好友总数的类。 属性 名称 类型 说明 textcount string 返回好友总数的本地化文本。该文本会自动翻译为与设备设置相匹配的语言。
