Class org.omus.msg.Mailbox

Implemented Interfaces

iObservable iMessageHandler

Description

Cette classe gère des objets Mail. Chaque client a deux mailBox : outBox and inBox. La référence à celles-ci s'obtient via User.

Evénements auxquels s'abonner :

Cette classe est aggrémentée par composition des méthodes des sources d'événements (EventDispatcher). Elle est aggrémentée par composition de la classe MessageHandler.

See Also

Field Index

type, unread

Method Index

new Mailbox()
_removeMail(), addHandler(), addListener(), addMail(), countListeners(), getLoaded(), getMail(), getTotal(), getType(), getUnread(), handleIncomingMessage(), handleMessage(), init(), load(), removeAll(), removeAllListeners(), removeListener(), sortByDate(), sortBySender(), sortBySubject(), toLog(), toString()

Constructor Detail

Mailbox

public function Mailbox(type:String)

L'objet Mailbox dispose des méthodes d'EventDispatcher et de celles de MessageHandler par composition.

Parameters

typeType de boîte : "in" / "out".

See Also

Field Detail

type

public type:String
Inbox ou Outbox

unread

public unread:Number
Nombre de mail non lus.

Method Detail

toString

public function toString():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

init

public function init(totalMail:Number, unreadMail:Number):Void

Initialisation d'une boîte aux lettres.

Parameters

totalMailNombre de mail maximal.
unreadMailNombre de mail non lus.

getType

public function getType():String

Renvoie le type de la boîte.

Return

Le type de boîte : "outBox" ou "inBox"

getTotal

public function getTotal():Number

Renvoie le nombre total de mails de la boîte.

Return

Le nombre toal de mail présents.

getUnread

public function getUnread():Number

Renvoie le nombre de mails non lus.

Return

Nombre de messages non lus.

getLoaded

public function getLoaded():Number

Renvoie un nombre de Mail chargés.

Return

Une quantité de mails chargés.

getMail

public function getMail(index:Number):Mail

Renvoie le mail selon son index. Par défaut, ils sont classés par date. o correspond au plus ancien Mail.

Parameters

indexIdentifiant du message.

Return

Une révérence à Mail.

See Also

load

public function load():Void

Charge tous les Mails valables. Génère une événement onLoad aux observateurs.

removeAll

public function removeAll():Void

Supprime tous les messages de la boîte courante.

sortByDate

public function sortByDate(ascending:Boolean):Void

Classe les mails par date.

Return

ascending true si classement par ordre croissant.

sortBySender

public function sortBySender(ascending:Boolean):Void

Classe les malis par envoyeur.

Parameters

ascendingtrue si classmeent par ordre croissant.

sortBySubject

public function sortBySubject(ascending:Boolean):Void

Classe les mails par sujet.

Parameters

ascendingtrue si classement dans l'ordre croissant.

_removeMail

public function _removeMail(mail:Mail, msgID:Number):Void

Supprime une mail de la boîte courante.

Parameters

mailRéférence à l'objet Mail à supprimer.
msgIDIdentifiant du Mail.

addMail

public function addMail(mail:Mail, msgID:Number):Void

Rajoute un Mail à la boîte courante.

Parameters

mailRéférence à l'objet Mail à supprimer.
msgIDIdentifiant du Mail.

addListener

public function addListener(listener:Object):Boolean

Ajoute un nouvel observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

addListener() in org.omus.util.iObservable

removeListener

public function removeListener(listener:Object):Boolean

Supprime un observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

removeListener() in org.omus.util.iObservable

removeAllListeners

public function removeAllListeners():Void

Supprime tous les abonnés.

Specified By

removeAllListeners() in org.omus.util.iObservable

countListeners

public function countListeners():Number

Retourne le nombre d'observateurs.

Return

Le nombre d'observateurs enregistrés.

Specified By

countListeners() in org.omus.util.iObservable

handleMessage

public function handleMessage(env:Envelope):Void

Active la gestion d'un type de message par accusé de réception en fonction du contenu de son enveloppe.

Parameters

envUne référence à l'enveloppe.

Specified By

handleMessage() in org.omus.msg.iMessageHandler

addHandler

public function addHandler(subject:String, methodName:String):Void

Rajoute un gestionnaire chargé d'intercepter la réponse du serveur suite à un message soumis. Forme d'accusé de réception (callback).

Parameters

subjectLe type de message.
methodNameLe nom de l'événement gérant un type de message.

Specified By

addHandler() in org.omus.msg.iMessageHandler

toLog

static public function toLog():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet.

handleIncomingMessage

static public function handleIncomingMessage(env:Envelope):Void

Gestionnaire d'accusé de réception émanant directement de MessageRouter et chargé de redistribuer les messages entre les propriétés d'un groupe ou d'un utilisateur. TODO : Compileur MMC 2004 n'accepte pas une méthode de classe et d'instance ayant le même nom.

Parameters

envEnveloppe du message.

See Also