ZEPETO.Module.Social

type description socialservice /#socialservice the socialservice implements social functionalities within zepeto world this service enables players to access social data, such as user's following relationships and provides the capability to send direct messages to other players roommemberstatus /#roommemberstatus enum representing the relationship with the local player myfollowerlistresponse /#myfollowerlistresponse the myfollowerlistresponse class provides the information of local player's follower list myfollowinglistresponse /#myfollowinglistresponse the myfollowinglistresponse class provides the api call result and the local player's following list information userfollowinfolistresponse /#userfollowinfolistresponse the userfollowinfolistresponse class provides the api call result and the users' following information list userfollowinforesponse /#userfollowinforesponse the userfollowinforesponse class provides the api call result and the user's following information list userfollowstatusresponse /#userfollowstatusresponse the userfollowstatusresponse class provides the api call result and the information indicating whether a specified user is in a following relationship with the local player directmessagepopupstate /#directmessagepopupstate enumerates states for direct message popup userinfo /#userinfo user information userfollowinfo /#userfollowinfo following information of a user useraccounttype /#useraccounttype enum representing the user account type followstatus /#followstatus represents the following relationship with the local player followcellview /#followcellview class for the official friends list popup userinfocellview /#userinfocellview class for ui elements that displays friend information in official friends list popup totalcountcellview /#totalcountcellview class for displaying the total number of friends in the official friends list popup socialservice class the socialservice implements social functionalities within zepeto world this service enables players to access social data, such as user's following relationships and provides the capability to send direct messages to other players methods add onroommemberstatuschanged static add onroommemberstatuschanged(value action\<string, roommemberstatus>) → void this asynchronous method retrieves the local player's list of followers parameter type value action\<string, roommemberstatus> getmyfollowinglistasync static getmyfollowinglistasync(nextpagetoken? string) → baserequest\<myfollowinglistresponse> this asynchronous method retrieves the local player's following list parameter type description nextpagetoken (optional) string page token when calling this method for the first time, set this parameter to null returns baserequest\<myfollowinglistresponse> — a baserequest object when the asynchronous process is complete, you can access the myfollowinglistresponse object by the responsedata property getuserfollowinfoasync static getuserfollowinfoasync(userids string\[]) → baserequest\<userfollowinfolistresponse> this asynchronous method retrieves follow information from multiple users parameter type description userids string\[] ids of users whose follow lists are to be searched returns baserequest\<userfollowinfolistresponse> — a baserequest object when the asynchronous process is complete, you can access the userfollowinfolistresponse object by the responsedata property getuserfollowinfoasync static getuserfollowinfoasync(userid string) → baserequest\<userfollowinforesponse> this asynchronous method retrieves follow information from a user parameter type description userid string id of the user whose follow lists are to be searched returns baserequest\<userfollowinforesponse> — a baserequest object when the asynchronous process is complete, you can access the userfollowinforesponse object by the responsedata property getuserfollowstatusasync static getuserfollowstatusasync(userid string) → baserequest\<userfollowstatusresponse> this asynchronous method retrieves the following relationship information between the local player and a user parameter type description userid string id of the user whose follow status is to be searched returns baserequest\<userfollowstatusresponse> — a baserequest object when the asynchronous process is complete, you can access the userfollowstatusresponse object by the responsedata property openpopupdirectmessage static openpopupdirectmessage(sendmessage string, userids? string\[], oncomplete? action\<directmessagepopupstate>) → void invokes a popup to send direct messages to users parameter type description sendmessage string the body of the message to send if it is blank or empty, the transmission will fail userids (optional) string\[] list of user ids for potential recipients if the users parameter is omitted, the recipient selection interface is automatically populated with users from the sender's follow/following list oncomplete (optional) action\<directmessagepopupstate> callback function to be called when message sending is completed or canceled roommemberstatus enum enum representing the relationship with the local player name value description none 0 indicates whether the local player is not following the user following 1 indicates whether the local player is following the user blocked 3 indicates whether the local player blocks the user myfollowerlistresponse class · extends playbaasresponse the myfollowerlistresponse class provides the information of local player's follower list properties name type description usercount number number of users that follow the local player users userinfo\[] /#userinfo information of the users that follow the local player nextpagetoken string the nextpagetoken is included in the response when numerous items are available, allowing retrieval of the subsequent follower list when no items remain, nextpagetoken is set to null myfollowinglistresponse class · extends playbaasresponse the myfollowinglistresponse class provides the api call result and the local player's following list information properties name type description usercount number number of users the local player is following users userinfo\[] /#userinfo information of the users that the local player is following bookmarkusers userinfo\[] /#userinfo information of the users that the local player has bookmarked nextpagetoken string the nextpagetoken is included in the response when numerous items are available, allowing retrieval of the subsequent following list when no items remain, nextpagetoken is set to null userfollowinfolistresponse class · extends baseresponse the userfollowinfolistresponse class provides the api call result and the users' following information list properties name type description users userfollowinfo\[] /#userfollowinfo array of the users' following information list userfollowinforesponse class · extends baseresponse the userfollowinforesponse class provides the api call result and the user's following information list properties name type description user userfollowinfo /#userfollowinfo array of the user's following information list userfollowstatusresponse class · extends playbaasresponse the userfollowstatusresponse class provides the api call result and the information indicating whether a specified user is in a following relationship with the local player properties name type description status followstatus /#followstatus specified user's following relationship with the local player directmessagepopupstate enum enumerates states for direct message popup name value description cancel 0 when the popup is manually closed or if the sending fails sendcomplete 1 when the send request is completed and it closes userinfo class user information properties name type description zepetoid string unique user handle, typically presented with the @ symbol userid string internal user identifier name string user's display name isofficialaccount boolean indicates whether this is an official account accounttype useraccounttype /#useraccounttype user account type followstatus followstatus /#followstatus following relationship with the local player methods getprofilethumbnailasync getprofilethumbnailasync() → baserequest\<textureresponse> this asynchronous method retrieves the thumbnail of user profile returns baserequest\<textureresponse> — a baserequest object when the asynchronous process is complete, you can access the textureresponse object by the responsedata property getbadgeimageasync getbadgeimageasync() → baserequest\<textureresponse> this asynchronous method retrieves the badge image from a user's profile if the user is a greeter or a creator account returns baserequest\<textureresponse> — a baserequest object when the asynchronous process is complete, you can access the textureresponse object by the responsedata property userfollowinfo class · extends userinfo /#userinfo following information of a user properties name type description followingcount number number of users being followed by the account followercount number number of followers for the account useraccounttype enum enum representing the user account type name value description default 0 common user greeter 1 account designated for the greeter program, designed to assist new users followstatus class represents the following relationship with the local player properties name type description isfollower boolean indicates whether the user is a follower of local player isfollowing boolean indicates whether the local player is following the user followcellview class · extends enhancedscrollercellview class for the official friends list popup properties name type description textfollowbutton string returns the localized text label to be displayed on the follow button within the official friends list popup the text is automatically translated into the language, matching the device settings textfollowingbutton string returns the localized text label to be displayed on the following button within the official friends list popup the text is automatically translated into the language, matching the device settings cellheight number returns the height of the user info cell view events name type description oncreated unityevent returns the event called when the official friends list popup is created ondeactivated unityevent returns the event called when the official friends list popup is deactivated onactivated unityevent returns the event called when the official friends list popup is activated userinfocellview class · extends followcellview /#followcellview class for ui elements that displays friend information in official friends list popup properties name type description userinfo userinfo /#userinfo returns the user information displayed on the ui textname string returns the account's user name displayed in ui totalcountcellview class · extends followcellview /#followcellview class for displaying the total number of friends in the official friends list popup properties name type description textcount string returns the localized text for the total number of friends the text is automatically translated into the language, matching the device settings