mozilla
Vos résultats de recherche

    nsISessionStore

    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.


    Please add a summary to this article.
      Last changed in Gecko 1.8.1 (Firefox 2 / Thunderbird 2 / SeaMonkey 1.1)

    Hérité de : nsISupports

    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);

    Méthodes

    deleteTabValue()

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

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

    deleteWindowValue()

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

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

    getBrowserState()

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

     AString getBrowserState();
    
    Valeur retournée

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

    getClosedTabCount()

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

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

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

    getClosedTabData()

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

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

    Une chaîne JSON représentant la liste des onglets fermés dans la fenêtre spécifiée dans <tt>aWindow</tt>. 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é.

    getTabValue()

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

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

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

    getWindowState()

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

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

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

    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
     );
    
    Paramètres
    <tt>aWindow</tt>
    La fenêtre pour laquelle la valeur doit être récupérée.
    <tt>aKey</tt>
    La clef dont la valeur correspondante doit être récupérée.
    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.

    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
     );
    
    Paramètres
    <tt>aWindow</tt>
    La fenêtre pour laquelle initialiser le service.

    setBrowserState()

    Définit l'état actuel du navigateur.

     void setBrowserState(
       in AString aState
     );
    
    Paramètres
    <tt>aState</tt>
    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 <tt>aState</tt>.

    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.
    Paramètres
    <tt>aName</tt>
    Le nom de l'attribut à sauvegarder et à restaurer pour tous les onglets.

    setTabValue()

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

     void setTabValue(
       in nsIDOMNode aTab,
       in AString aKey,
       in AString aStringValue
     );
    
    Paramètres
    <tt>aTab</tt>
    L'onglet pour lequel appliquer la valeur.
    <tt>aKey</tt>
    La clef dont la valeur doit être appliquée.
    <tt>aStringValue</tt>
    Une chaîne à définir comme étant la valeur de la clef <tt>aKey</tt>. 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).

    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
     );
    
    Paramètres
    <tt>aWindow</tt>
    La fenêtre du navigateur dont l'état doit être défini par celui indiqué dans <tt>aState</tt>.
    <tt>aState</tt>
    L'état de sauvegarde à appliquer à la fenêtre spécifiée.
    <tt>aOverwrite</tt>
    Si le paramètre est égal à true, tous les onglets existants sont fermés et remplacés par ceux contenus dans le paramètre <tt>aState</tt>. S'il est égal à false, les onglets contenus dans <tt>aState</tt> sont ajoutés à la suite de ceux déjà ouverts dans la fenêtre.

    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
     );
    
    Paramètres
    <tt>aWindow</tt>
    La fenêtre pour laquelle la valeur doit être appliquée.
    <tt>aKey</tt>
    La clef dont la valeur doit être appliquée.
    <tt>aStringValue</tt>
    Une chaîne à appliquer telle que la valeur de la clef <tt>aKey</tt>. 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).

    undoCloseTab()

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

     void undoCloseTab(
       in nsIDOMWindow aWindow,
       in unsigned long aIndex
     );
    
    Paramètres
    <tt>aWindow</tt>
    La fenêtre dans laquelle rouvrir un onglet précédemment fermé.
    <tt>aIndex</tt>
    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é.

    Voir également

    nsISupports

    Interwikis Languages Links

    Étiquettes et contributeurs liés au document

    Contributors to this page: VincentN, Gomita, Fredchat, Kyodev
    Dernière mise à jour par : Fredchat,