Cette classe gère les groupes d'utilisateurs et plus particulièrement celui dont fait partie l'utilisateur client. Chaque groupe doit être déclaré dans le fichier config.xml. La création de groupe dynamique s'obtient en utilisant un configID valide avec un nouveau nom groupName. Un nombre illimité de groupe peut partagé la même valeur de configID définit dans le config.xml.
Evénements auxquels s'abonner :
public function toString():StringUtilisé dans un contexte littéral
Une chaine définissant l'objet
public function getConfigID():StringRenvoie l'identifiant statique d'un groupe de groupe.
Un identifiant correspondant au nœud
public function getUserCount():NumberRenvoie le nombre d'inscrits dans ce groupe.
Le nombre d'inscript.
public function getUserLimit():NumberRenvoie la limite d'utilisateurs simultanés dans un groupe.
Nombre maximum d'inscrits.
public function isClosed():BooleanRenvoie si un verrou a été posé sur le groupe de telle faço qu'aucun nouveau utilisateur puissse s'inscrire.
true si le verrou est posé, sinon false.
public function isFull():BooleanAvertissement quant au seuil maximal de membres inscrits dans un groupe.
true si le seuil est atteint, sinon false.
public function getProperties():PropertySetRenvoie les propriétés persistantes rattachées à un groupe.
Un objet PropertySet correspondant au groupe actuel.
public function getUserProperties(username:String):PropertySetRenvoie les propriétés persistantes en fonction dun nom d'un utilisateur inscript.
Un objet PropertySet définissant un membre du groupe.
public function getAllUserProperties():ArrayRenvoie une liste de toutes les propriétés persistantes de chaque membre du groupe.
Une liste d'utilisateurs et leurs propriétés.
public function containsUser(username:String):BooleanRenvoie si un membre appartient à ce groupe.
username | Le nom d'utilisateur. |
true si l'utilisateur est membre du groupe.
public function close():VoidCloture un groupe pour que personne ne puisse y pénétrer à nouveau.
public function change(groupName:String, configID:String, syncProps:Boolean):Void
Permet de quitter un groupe pour en rejoindre un nouveau.
Cette méthode a double emploi :
- Elle fait entrer un membre dans un groupe déjà enregistré.
Auquel cas, il est possible de passer null en second argument.
- Elle crée un nouveau groupe si l'identifiant de configID est valide,
c'est à dire qu'il est contenu dans le nœud
groupName | Nom du groupe à rejoindre ou à créer dynamiquement. |
configID | Identifiant du groupe de groupe, [null] si groupName existe déjà. |
syncProps | Le souhait de synchroniser les propriétés persistantes automatiquement, sans invoquer PropertySet.synchronize() Cela aura aussi effet de générer les événements PropertySet.onSynchronise() et Group.onChange(). En cas d'échec, toutes les propriétés affectées sont supprimées. |
public function addListener(listener:Object):BooleanAjoute un nouvel observateur.
listener | Référence de l'observateur. |
Un booléen indiquant la réussite de l'opération.
public function removeListener(listener:Object):BooleanSupprime un observateur.
listener | Référence de l'observateur. |
Un booléen indiquant la réussite de l'opération.
public function countListeners():NumberRetourne le nombre d'observateurs.
Le nombre d'observateurs enregistrés.
public function handleMessage(env:Envelope):VoidActive la gestion d'un type de message par accusé de réception en fonction du contenu de son enveloppe.
env | Une référence à l'enveloppe. |
public function addHandler(subject:String, methodName:String):VoidRajoute un gestionnaire chargé d'intercepter la réponse du serveur suite à un message soumis. Forme d'accusé de réception (callback).
subject | Le type de message. |
methodName | Le nom de l'événement gérant un type de message. |
static public function toLog():StringUtilisé dans un contexte littéral
Une chaine définissant l'objet.
static public function getInstance(propConfig:Object):GroupAccès global à la référence du Singleton
Une référence à la classe