Skip to main content

Visit Mozilla.org

nsISessionStore

Un article de MDC.


L'interface nsISessionStore fournit un moyen aux extensions ou a tout autre morceau de code, de stocker des données en association avec les sessions du navigateur, les onglets et les fenêtres. Voir également l'article Session store API.

Sommaire


nsISessionStore est définie dans browser/components/sessionstore/nsISessionStore.idl, et elle est non figée (n'a pas été modifiée depuis Mozilla 1.8.1). Cette interface est scriptable.

Hérité de : nsISupports

[modifier] Synoptique

void deleteTabValue(in nsIDOMNode aTab, in AString aKey);
void deleteWindowValue(in nsIDOMWindow aWindow, in AString aKey);
AString getBrowserState();
unsigned long getClosedTabCount(in nsIDOMWindow aWindow);
AString getClosedTabData(in nsIDOMWindow aWindow);
AString getTabValue(in nsIDOMNode aTab, in AString aKey);
AString getWindowState(in nsIDOMWindow aWindow);
AString getWindowValue(in nsIDOMWindow aWindow, in AString aKey);
void init(in nsIDOMWindow aWindow);
void persistTabAttribute(in AString aName);
void setBrowserState(in AString aState);
void setTabValue(in nsIDOMNode aTab, in AString aKey, in AString aStringValue);
void setWindowState(in nsIDOMWindow aWindow, in AString aState, in boolean aOverwrite);
void setWindowValue(in nsIDOMWindow aWindow, in AString aKey, in AString aStringValue);
void undoCloseTab(in nsIDOMWindow aWindow, in unsigned long aIndex);

[modifier] Méthodes

[modifier] deleteTabValue()

Efface une valeur de la fenêtre spécifiée. 

 void deleteTabValue(
   in nsIDOMNode aTab,
   in AString aKey
 );
[modifier] Paramètres
aTab
L'onglet pour lequel effacer la valeur.
aKey
La clef dont la valeur doit être effacée.

[modifier] deleteWindowValue()

Efface une valeur de la fenêtre spécifiée. 

 void deleteWindowValue(
   in nsIDOMWindow aWindow,
   in AString aKey
 );
[modifier] Paramètres
aWindow
La fenêtre dans laquelle effacer la valeur.
aKey
La clef dont la valeur doit être effacée.

[modifier] getBrowserState()

Retourne l'état actuel du navigateur, comprenant tous les onglets ouverts dans toutes les fenêtres. 

 AString getBrowserState();
[modifier] Valeur retournée

Une chaîne JSON représentant l'état actuel de la session.

[modifier] getClosedTabCount()

Retourne le nombre total d'onglets pouvant être restauré pour une fenêtre donnée. 

 unsigned long getClosedTabCount(
   in nsIDOMWindow aWindow
 );
[modifier] Paramètres
aWindow
La fenêtre pour laquelle le nombre d'onglets pouvant être restaurés doit être retourné.
[modifier] Valeur retournée

Le nombre d'onglets de la fenêtre pouvant être restaurés.

[modifier] getClosedTabData()

Retourne la liste des onglets fermés pour une fenêtre spécifiée. 

 AString getClosedTabData(
   in nsIDOMWindow aWindow
 );
[modifier] Paramètres
aWindow
La fenêtre pour laquelle la liste des onglets fermés doit être retournée.
[modifier] Valeur retournée

Une chaîne JSON représentant la liste des onglets fermés dans la fenêtre spécifiée dans aWindow. La liste est classée dans l'ordre dernier ouvert/Premier fermé (LIFO), ainsi le premier élément de la liste est le dernier onglet qui a été fermé.

[modifier] getTabValue()

Retourne la valeur correspondante à une clef d'une fenêtre donnée. 

 AString getTabValue(
   in nsIDOMNode aTab,
   in AString aKey
 );
[modifier] Paramètres
aTab
L'onglet pour lequel récupérer la valeur.
aKey
La clef dont la valeur correspondante doit être retournée.
[modifier] Valuer retournée

La valeur de la chaîne précédemment assignée à aKey par setTabValue().

[modifier] getWindowState()

Retourne l'état actuel de la fenêtre de navigateur spécifiée. 

 AString getWindowState(
   in nsIDOMWindow aWindow
 );
[modifier] Paramètres
aWindow
La fenêtre du navigateur pour laquelle l'état doit être retourné.
[modifier] Valeur retournée

Une chaîne JSON représentant l'état de la session qui contient uniquement la fenêtre spécifiée dans aWindow.

[modifier] getWindowValue()

Retourner la valeur de la chaîne associée à une clef donnée pour une fenêtre. 

 AString getWindowValue(
   in nsIDOMWindow aWindow,
   in AString aKey
 );
[modifier] Paramètres
aWindow
La fenêtre pour laquelle la valeur doit être récupérée.
aKey
La clef dont la valeur correspondante doit être récupérée.
[modifier] Valeur retournée

La valeur de la chaîne précédemment sauvegardée pour la clef spécifiée, ou une chaîne vide si aucune valeur n'a été définie pour cette clef.

[modifier] init()

Initialise le service de gestion de sessions.

Note : Cette fonction est uniquement destinée à être utilisée par le navigateur ; les extensions ne devraient pas l'utiliser.
 void init(
   in nsIDOMWindow aWindow
 );
[modifier] Paramètres
aWindow
La fenêtre pour laquelle initialiser le service.

[modifier] setBrowserState()

Définit l'état actuel du navigateur. 

 void setBrowserState(
   in AString aState
 );
[modifier] Paramètres
aState
Une chaîne JSON représentant l'état de session à utiliser.
Note : Appeler setBrowserState() remplace immédiatement la session courante, en restaurant l'état complet de l'application dans l'état indiqué par le paramètre aState.

[modifier] persistTabAttribute()

Définit le nom d'un attribut d'onglet à sauvegarder et à restaurer pour tous les onglets XUL. 

 void persistTabAttribute(
   in AString aName
 );
Note : Actuellement, il n'y a aucun moyen de récupérer et de choisir les onglets pour lesquels appliquer des attributs persistants. Cette méthode affecte tous les onglets sans discrimination.
[modifier] Paramètres
aName
Le nom de l'attribut à sauvegarder et à restaurer pour tous les onglets.

[modifier] setTabValue()

Applique la valeur de la clef spécifiée à un onglet. 

 void setTabValue(
   in nsIDOMNode aTab,
   in AString aKey,
   in AString aStringValue
 );
[modifier] Paramètres
aTab
L'onglet pour lequel appliquer la valeur.
aKey
La clef dont la valeur doit être appliquée.
aStringValue
Une chaîne à définir comme étant la valeur de la clef aKey. Vous pouvez utiliser la méthode toSource() sur des objets JavaScript, ou la fonction eval(), pour assigner comme valeur des données plus complexes (voire des objets entiers).

[modifier] setWindowState()

Applique la valeur enregistrée donnée à l'état de la fenêtre spécifiée. 

 void setWindowState(
   in nsIDOMWindow aWindow,
   in AString aState,
   in boolean aOverwrite
 );
[modifier] Paramètres
aWindow
La fenêtre du navigateur dont l'état doit être défini par celui indiqué dans aState.
aState
L'état de sauvegarde à appliquer à la fenêtre spécifiée.
aOverwrite
Si le paramètre est égal à true, tous les onglets existants sont fermés et remplacés par ceux contenus dans le paramètre aState. S'il est égal à false, les onglets contenus dans aState sont ajoutés à la suite de ceux déjà ouverts dans la fenêtre.

[modifier] setWindowValue()

Applique la valeur correspondante à une clef donnée pour la fenêtre spécifiée. 

 void setWindowValue(
   in nsIDOMWindow aWindow,
   in AString aKey,
   in AString aStringValue
 );
[modifier] Paramètres
aWindow
La fenêtre pour laquelle la valeur doit être appliquée.
aKey
La clef dont la valeur doit être appliquée.
aStringValue
Une chaîne à appliquer telle que la valeur de la clef aKey. Vous pouvez utiliser la méthode toSource() sur des objets JavaScript, ou la fonction eval(), pour assigner comme valeur des données plus complexes (voire même des objets entiers).

[modifier] undoCloseTab()

Rouvre un onglet fermé dans la fenêtre spécifée. 

 void undoCloseTab(
   in nsIDOMWindow aWindow,
   in unsigned long aIndex
 );
[modifier] Paramètres
aWindow
La fenêtre dans laquelle rouvrir un onglet précédemment fermé.
aIndex
Le numéro d'index de l'onglet à restaurer. Cette valeur doit être comprise entre 0 et la valeur retournée par getClosedTabCount() diminuée de 1. La liste des onglets fermés est stockée dans l'ordre dernier ouvert/premier fermé (LIFO), ainsi l'onglet d'index 0 est le dernier à avoir été fermé.

[modifier] Voir également

nsISupports

Récupérée de « http://developer.mozilla.org/fr/docs/nsISessionStore »