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 アカウントの場合に、そのプロフィールからバッジ画像を非同期で取得するメソッドです。

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	フレンドの総数を示すローカライズ済みのテキストを返します。テキストはデバイスの設定に合わせた言語へ自動的に翻訳されます。