ZEPETO.Module.Social

30 분

형식	설명
SocialService	SocialService는 ZEPETO World 내의 소셜 기능을 구현합니다. 이 서비스를 통해 플레이어는 사용자의 팔로우 관계와 같은 소셜 데이터에 접근할 수 있습니다. 또한 다른 플레이어에게 다이렉트 메시지를 보내는 기능을 제공합니다.
RoomMemberStatus	로컬 플레이어와의 관계를 나타내는 열거형입니다.
MyFollowerListResponse	MyFollowerListResponse 클래스는 로컬 플레이어의 팔로워 목록 정보를 제공합니다.
MyFollowingListResponse	MyFollowingListResponse 클래스는 API 호출 결과와 로컬 플레이어의 팔로잉 목록 정보를 제공합니다.
UserFollowInfoListResponse	UserFollowInfoListResponse 클래스는 API 호출 결과와 여러 사용자의 팔로우 정보 목록을 제공합니다.
UserFollowInfoResponse	UserFollowInfoResponse 클래스는 API 호출 결과와 사용자의 팔로우 정보 목록을 제공합니다.
UserFollowStatusResponse	UserFollowStatusResponse 클래스는 API 호출 결과와, 지정한 사용자가 로컬 플레이어와 팔로우 관계인지를 나타내는 정보를 제공합니다.
DirectMessagePopupState	다이렉트 메시지 팝업의 상태를 열거합니다.
UserInfo	사용자 정보입니다.
UserFollowInfo	사용자의 팔로우 정보입니다.
UserAccountType	사용자 계정 유형을 나타내는 열거형입니다.
FollowStatus	로컬 플레이어와의 팔로우 관계를 나타냅니다.
FollowCellView	공식 친구 목록 팝업을 위한 클래스입니다.
UserInfoCellView	공식 친구 목록 팝업에서 친구 정보를 표시하는 UI 요소를 위한 클래스입니다.
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[]	로컬 플레이어를 팔로우하는 사용자의 정보입니다.
nextPageToken	string	항목이 많은 경우 응답에 nextPageToken이 포함되어 이후의 팔로워 목록을 가져올 수 있습니다. 남은 항목이 없으면 nextPageToken은 null이 됩니다.

MyFollowingListResponse

class · extends PlayBaasResponse

MyFollowingListResponse 클래스는 API 호출 결과와 로컬 플레이어의 팔로잉 목록 정보를 제공합니다.

속성

이름	형식	설명
userCount	number	로컬 플레이어가 팔로우하는 사용자 수입니다.
users	UserInfo[]	로컬 플레이어가 팔로우하는 사용자의 정보입니다.
bookMarkUsers	UserInfo[]	로컬 플레이어가 북마크한 사용자의 정보입니다.
nextPageToken	string	항목이 많은 경우 응답에 nextPageToken이 포함되어 이후의 팔로잉 목록을 가져올 수 있습니다. 남은 항목이 없으면 nextPageToken은 null이 됩니다.

UserFollowInfoListResponse

class · extends BaseResponse

UserFollowInfoListResponse 클래스는 API 호출 결과와 여러 사용자의 팔로우 정보 목록을 제공합니다.

속성

이름	형식	설명
users	UserFollowInfo[]	여러 사용자의 팔로우 정보 목록 배열입니다.

UserFollowInfoResponse

class · extends BaseResponse

UserFollowInfoResponse 클래스는 API 호출 결과와 사용자의 팔로우 정보 목록을 제공합니다.

속성

이름	형식	설명
user	UserFollowInfo	사용자의 팔로우 정보 목록 배열입니다.

UserFollowStatusResponse

class · extends PlayBaasResponse

UserFollowStatusResponse 클래스는 API 호출 결과와, 지정한 사용자가 로컬 플레이어와 팔로우 관계인지를 나타내는 정보를 제공합니다.

속성

이름	형식	설명
status	FollowStatus	지정한 사용자와 로컬 플레이어의 팔로우 관계입니다.

DirectMessagePopupState

enum

다이렉트 메시지 팝업의 상태를 열거합니다.

이름	값	설명
Cancel	0	팝업을 직접 닫았거나 전송에 실패한 경우입니다.
SendComplete	1	전송 요청이 완료되어 팝업이 닫힌 경우입니다.

UserInfo

class

사용자 정보입니다.

속성

이름	형식	설명
zepetoId	string	사용자 고유 핸들이며, 일반적으로 @ 기호와 함께 표시됩니다.
userId	string	내부 사용자 식별자입니다.
name	string	사용자의 표시 이름입니다.
isOfficialAccount	boolean	공식 계정인지 여부를 나타냅니다.
accountType	UserAccountType	사용자 계정 유형입니다.
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

사용자의 팔로우 정보입니다.

속성

이름	형식	설명
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

공식 친구 목록 팝업에서 친구 정보를 표시하는 UI 요소를 위한 클래스입니다.

속성

이름	형식	설명
userInfo	UserInfo	UI에 표시되는 사용자 정보를 반환합니다.
textName	string	UI에 표시되는 계정의 사용자 이름을 반환합니다.

TotalCountCellView

class · extends FollowCellView

공식 친구 목록 팝업에서 친구 총 수를 표시하기 위한 클래스입니다.

속성

이름	형식	설명
textCount	string	친구 총 수를 나타내는 현지화된 텍스트를 반환합니다. 텍스트는 기기 설정에 맞는 언어로 자동 번역됩니다.