ZEPETO.Module.Social

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