ZEPETO.Module.Social

31 min

Type	Description
SocialService	Le SocialService implémente les fonctionnalités sociales au sein du ZEPETO World. Ce service permet aux joueurs d'accéder aux données sociales, telles que les relations de suivi entre utilisateurs. Il offre également la possibilité d'envoyer des messages directs à d'autres joueurs.
RoomMemberStatus	Énumération représentant la relation avec le joueur local.
MyFollowerListResponse	La classe MyFollowerListResponse fournit les informations sur la liste des abonnés du joueur local.
MyFollowingListResponse	La classe MyFollowingListResponse fournit le résultat de l'appel d'API ainsi que les informations sur la liste des abonnements du joueur local.
UserFollowInfoListResponse	La classe UserFollowInfoListResponse fournit le résultat de l'appel d'API ainsi que la liste des informations de suivi des utilisateurs.
UserFollowInfoResponse	La classe UserFollowInfoResponse fournit le résultat de l'appel d'API ainsi que la liste des informations de suivi de l'utilisateur.
UserFollowStatusResponse	La classe UserFollowStatusResponse fournit le résultat de l'appel d'API ainsi que les informations indiquant si un utilisateur donné est en relation de suivi avec le joueur local.
DirectMessagePopupState	Énumère les états de la fenêtre contextuelle de message direct.
UserInfo	Informations sur l'utilisateur.
UserFollowInfo	Informations de suivi d'un utilisateur.
UserAccountType	Énumération représentant le type de compte utilisateur.
FollowStatus	Représente la relation de suivi avec le joueur local.
FollowCellView	Classe correspondant à la fenêtre contextuelle de la liste d'amis officielle.
UserInfoCellView	Classe correspondant aux éléments d'interface qui affichent les informations d'un ami dans la fenêtre contextuelle de la liste d'amis officielle.
TotalCountCellView	Classe permettant d'afficher le nombre total d'amis dans la fenêtre contextuelle de la liste d'amis officielle.

SocialService

class

Le SocialService implémente les fonctionnalités sociales au sein du ZEPETO World. Ce service permet aux joueurs d'accéder aux données sociales, telles que les relations de suivi entre utilisateurs. Il offre également la possibilité d'envoyer des messages directs à d'autres joueurs.

Méthodes

add_onRoomMemberStatusChanged

static add_onRoomMemberStatusChanged(value: Action<string, RoomMemberStatus>) → void

Cette méthode asynchrone récupère la liste des abonnés du joueur local.

Paramètre	Type
value	Action<string, RoomMemberStatus>

GetMyFollowingListAsync

static GetMyFollowingListAsync(nextPageToken?: string) → BaseRequest<MyFollowingListResponse>

Cette méthode asynchrone récupère la liste des abonnements du joueur local.

Paramètre	Type	Description
nextPageToken (facultatif)	string	Jeton de page. Lors du premier appel de cette méthode, définissez ce paramètre sur null.

Renvoie : BaseRequest<MyFollowingListResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet MyFollowingListResponse via la propriété responseData.

GetUserFollowInfoAsync

static GetUserFollowInfoAsync(userIds: string[]) → BaseRequest<UserFollowInfoListResponse>

Cette méthode asynchrone récupère les informations de suivi de plusieurs utilisateurs.

Paramètre	Type	Description
userIds	string[]	ID des utilisateurs dont les listes de suivi doivent être recherchées.

Renvoie : BaseRequest<UserFollowInfoListResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet UserFollowInfoListResponse via la propriété responseData.

GetUserFollowInfoAsync

static GetUserFollowInfoAsync(userId: string) → BaseRequest<UserFollowInfoResponse>

Cette méthode asynchrone récupère les informations de suivi d'un utilisateur.

Paramètre	Type	Description
userId	string	ID de l'utilisateur dont les listes de suivi doivent être recherchées.

Renvoie : BaseRequest<UserFollowInfoResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet UserFollowInfoResponse via la propriété responseData.

GetUserFollowStatusAsync

static GetUserFollowStatusAsync(userId: string) → BaseRequest<UserFollowStatusResponse>

Cette méthode asynchrone récupère les informations relatives à la relation de suivi entre le joueur local et un utilisateur.

Paramètre	Type	Description
userId	string	ID de l'utilisateur dont l'état de suivi doit être recherché.

Renvoie : BaseRequest<UserFollowStatusResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet UserFollowStatusResponse via la propriété responseData.

OpenPopupDirectMessage

static OpenPopupDirectMessage(sendMessage: string, userIds?: string[], onComplete?: Action<DirectMessagePopupState>) → void

Ouvre une fenêtre contextuelle permettant d'envoyer des messages directs à des utilisateurs.

Paramètre	Type	Description
sendMessage	string	Corps du message à envoyer. S'il est vide ou ne contient que des espaces, l'envoi échouera.
userIds (facultatif)	string[]	Liste des ID des destinataires potentiels. Si le paramètre users est omis, l'interface de sélection des destinataires est automatiquement remplie avec les utilisateurs issus de la liste d'abonnés/abonnements de l'expéditeur.
onComplete (facultatif)	Action<DirectMessagePopupState>	Fonction de callback appelée lorsque l'envoi du message est terminé ou annulé.

RoomMemberStatus

enum

Énumération représentant la relation avec le joueur local.

Nom	Valeur	Description
None	0	Indique si le joueur local ne suit pas l'utilisateur.
Following	1	Indique si le joueur local suit l'utilisateur.
Blocked	3	Indique si le joueur local a bloqué l'utilisateur.

MyFollowerListResponse

class · extends PlayBaasResponse

La classe MyFollowerListResponse fournit les informations sur la liste des abonnés du joueur local.

Propriétés

Nom	Type	Description
userCount	number	Nombre d'utilisateurs qui suivent le joueur local.
users	UserInfo[]	Informations sur les utilisateurs qui suivent le joueur local.
nextPageToken	string	Le nextPageToken est inclus dans la réponse lorsque de nombreux éléments sont disponibles, ce qui permet de récupérer la suite de la liste des abonnés. Lorsqu'il ne reste plus d'éléments, nextPageToken vaut null.

MyFollowingListResponse

class · extends PlayBaasResponse

La classe MyFollowingListResponse fournit le résultat de l'appel d'API ainsi que les informations sur la liste des abonnements du joueur local.

Propriétés

Nom	Type	Description
userCount	number	Nombre d'utilisateurs suivis par le joueur local.
users	UserInfo[]	Informations sur les utilisateurs suivis par le joueur local.
bookMarkUsers	UserInfo[]	Informations sur les utilisateurs mis en favori par le joueur local.
nextPageToken	string	Le nextPageToken est inclus dans la réponse lorsque de nombreux éléments sont disponibles, ce qui permet de récupérer la suite de la liste des abonnements. Lorsqu'il ne reste plus d'éléments, nextPageToken vaut null.

UserFollowInfoListResponse

class · extends BaseResponse

La classe UserFollowInfoListResponse fournit le résultat de l'appel d'API ainsi que la liste des informations de suivi des utilisateurs.

Propriétés

Nom	Type	Description
users	UserFollowInfo[]	Tableau contenant la liste des informations de suivi des utilisateurs.

UserFollowInfoResponse

class · extends BaseResponse

La classe UserFollowInfoResponse fournit le résultat de l'appel d'API ainsi que la liste des informations de suivi de l'utilisateur.

Propriétés

Nom	Type	Description
user	UserFollowInfo	Tableau contenant la liste des informations de suivi de l'utilisateur.

UserFollowStatusResponse

class · extends PlayBaasResponse

La classe UserFollowStatusResponse fournit le résultat de l'appel d'API ainsi que les informations indiquant si un utilisateur donné est en relation de suivi avec le joueur local.

Propriétés

Nom	Type	Description
status	FollowStatus	Relation de suivi de l'utilisateur spécifié avec le joueur local.

DirectMessagePopupState

enum

Énumère les états de la fenêtre contextuelle de message direct.

Nom	Valeur	Description
Cancel	0	Lorsque la fenêtre contextuelle est fermée manuellement ou que l'envoi échoue.
SendComplete	1	Lorsque la demande d'envoi est terminée et que la fenêtre se ferme.

UserInfo

class

Informations sur l'utilisateur.

Propriétés

Nom	Type	Description
zepetoId	string	Identifiant unique de l'utilisateur, généralement présenté avec le symbole @.
userId	string	Identifiant interne de l'utilisateur.
name	string	Nom d'affichage de l'utilisateur.
isOfficialAccount	boolean	Indique s'il s'agit d'un compte officiel.
accountType	UserAccountType	Type de compte utilisateur.
followStatus	FollowStatus	Relation de suivi avec le joueur local.

Méthodes

GetProfileThumbnailAsync

GetProfileThumbnailAsync() → BaseRequest<TextureResponse>

Cette méthode asynchrone récupère la vignette du profil de l'utilisateur.

Renvoie : BaseRequest<TextureResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet TextureResponse via la propriété responseData.

GetBadgeImageAsync

GetBadgeImageAsync() → BaseRequest<TextureResponse>

Cette méthode asynchrone récupère l'image du badge du profil de l'utilisateur si celui-ci possède un compte Greeter ou Creator.

Renvoie : BaseRequest<TextureResponse> — Un objet BaseRequest. Une fois le traitement asynchrone terminé, vous pouvez accéder à l'objet TextureResponse via la propriété responseData.

UserFollowInfo

class · extends UserInfo

Informations de suivi d'un utilisateur.

Propriétés

Nom	Type	Description
followingCount	number	Nombre d'utilisateurs suivis par le compte.
followerCount	number	Nombre d'abonnés du compte.

UserAccountType

enum

Énumération représentant le type de compte utilisateur.

Nom	Valeur	Description
Default	0	Utilisateur ordinaire.
Greeter	1	Compte désigné pour le programme Greeter, destiné à accompagner les nouveaux utilisateurs.

FollowStatus

class

Représente la relation de suivi avec le joueur local.

Propriétés

Nom	Type	Description
isFollower	boolean	Indique si l'utilisateur est un abonné du joueur local.
isFollowing	boolean	Indique si le joueur local suit l'utilisateur.

FollowCellView

class · extends EnhancedScrollerCellView

Classe correspondant à la fenêtre contextuelle de la liste d'amis officielle.

Propriétés

Nom	Type	Description
textFollowButton	string	Renvoie le libellé localisé à afficher sur le bouton Follow dans la fenêtre contextuelle de la liste d'amis officielle. Le texte est automatiquement traduit dans la langue correspondant aux paramètres de l'appareil.
textFollowingButton	string	Renvoie le libellé localisé à afficher sur le bouton Following dans la fenêtre contextuelle de la liste d'amis officielle. Le texte est automatiquement traduit dans la langue correspondant aux paramètres de l'appareil.
cellHeight	number	Renvoie la hauteur de la cellule d'informations utilisateur.

Événements

Nom	Type	Description
onCreated	UnityEvent	Renvoie l'événement appelé lors de la création de la fenêtre contextuelle de la liste d'amis officielle.
onDeactivated	UnityEvent	Renvoie l'événement appelé lors de la désactivation de la fenêtre contextuelle de la liste d'amis officielle.
onActivated	UnityEvent	Renvoie l'événement appelé lors de l'activation de la fenêtre contextuelle de la liste d'amis officielle.

UserInfoCellView

class · extends FollowCellView

Classe correspondant aux éléments d'interface qui affichent les informations d'un ami dans la fenêtre contextuelle de la liste d'amis officielle.

Propriétés

Nom	Type	Description
userInfo	UserInfo	Renvoie les informations utilisateur affichées dans l'interface.
textName	string	Renvoie le nom d'utilisateur du compte affiché dans l'interface.

TotalCountCellView

class · extends FollowCellView

Classe permettant d'afficher le nombre total d'amis dans la fenêtre contextuelle de la liste d'amis officielle.

Propriétés

Nom	Type	Description
textCount	string	Renvoie le texte localisé indiquant le nombre total d'amis. Le texte est automatiquement traduit dans la langue correspondant aux paramètres de l'appareil.