SocialService
ZEPETO.Module.Social.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.
Hierarchy
↳
SocialService
Constructors
constructor
• new SocialService()
Inherited from
System.Object.constructor
Methods
GetMyFollowerListAsync
▸ Static GetMyFollowerListAsync($nextPageToken?): BaseRequest$1<MyFollowerListResponse>
This asynchronous method retrieves the local player's list of followers.
Parameters
| Name | Type | Description |
|---|---|---|
$nextPageToken? | string | Optional Page token. When calling this method for the first time, set this parameter to null. |
Returns
BaseRequest$1<MyFollowerListResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the MyFollowerListResponse object by the responseData property.
GetMyFollowingListAsync
▸ Static GetMyFollowingListAsync($nextPageToken?): BaseRequest$1<MyFollowingListResponse>
This asynchronous method retrieves the local player's following list.
Parameters
| Name | Type | Description |
|---|---|---|
$nextPageToken? | string | Optional Page token. When calling this method for the first time, set this parameter to null. |
Returns
BaseRequest$1<MyFollowingListResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the MyFollowingListResponse object by the responseData property.
GetUserFollowInfoAsync
▸ Static GetUserFollowInfoAsync($userIds): BaseRequest$1<UserFollowInfoListResponse>
This asynchronous method retrieves follow information from multiple users.
Parameters
| Name | Type | Description |
|---|---|---|
$userIds | string[] | IDs of users whose follow lists are to be searched. |
Returns
BaseRequest$1<UserFollowInfoListResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the UserFollowInfoListResponse object by the responseData property.
▸ Static GetUserFollowInfoAsync($userId): BaseRequest$1<UserFollowInfoResponse>
This asynchronous method retrieves follow information from a user.
Parameters
| Name | Type | Description |
|---|---|---|
$userId | string | ID of the user whose follow lists are to be searched. |
Returns
BaseRequest$1<UserFollowInfoResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the UserFollowInfoResponse object by the responseData property.
GetUserFollowStatusAsync
▸ Static GetUserFollowStatusAsync($userId): BaseRequest$1<UserFollowStatusResponse>
This asynchronous method retrieves the following relationship information between the local player and a user.
Parameters
| Name | Type | Description |
|---|---|---|
$userId | string | ID of the user whose follow status is to be searched. |
Returns
BaseRequest$1<UserFollowStatusResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the UserFollowStatusResponse object by the responseData property.
OpenPopupDirectMessage
▸ Static OpenPopupDirectMessage($sendMessage, $userIds?, $onComplete?): void
Invokes a popup to send direct messages to users.
Parameters
| Name | Type | Description |
|---|---|---|
$sendMessage | string | The body of the message to send. If it is blank or empty, the transmission will fail. |
$userIds? | string[] | Optional 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? | Action$1<DirectMessagePopupState> | Optional Callback function to be called when message sending is completed or canceled. |
Returns
void