Démarrage automatique

Démarrage automatique

app.Autostart enregistre votre application pour qu’elle se lance automatiquement lorsque l’utilisateur se connecte. Il sélectionne le mécanisme natif adapté à chaque plateforme et résout les chemins d’installation comportant des liens symboliques (Homebrew, Scoop), afin que les enregistrements restent valides lors de la mise à niveau du binaire.

L’enregistrement prend effet à la prochaine connexion, et non immédiatement.

Démarrage rapide

import "github.com/wailsapp/wails/v3/pkg/application"

// Register to launch at login
if err := app.Autostart.Enable(); err != nil {
    app.Logger.Error("autostart enable failed", "error", err)
}

// Stop launching at login
if err := app.Autostart.Disable(); err != nil {
    app.Logger.Error("autostart disable failed", "error", err)
}

// Check status
enabled, err := app.Autostart.IsEnabled()

API

Enable

Enregistre l’application pour qu’elle se lance à la connexion avec les options par défaut.

func (m *AutostartManager) Enable() error

Vous pouvez appeler Enable plusieurs fois sans risque : l’enregistrement est remplacé à chaque appel. Vous pouvez donc l’appeler à chaque démarrage si vous avez conservé la préférence de l’utilisateur.

EnableWithOptions

Effectue l’enregistrement avec des options personnalisées.

func (m *AutostartManager) EnableWithOptions(opts AutostartOptions) error

AutostartOptions :

Disable

Supprime l’enregistrement du démarrage automatique. Renvoie nil si l’application n’était pas enregistrée : la désactivation est idempotente.

func (m *AutostartManager) Disable() error

IsEnabled

Indique s’il existe un enregistrement. Cette opération est rapide, car elle ne valide pas le chemin enregistré.

func (m *AutostartManager) IsEnabled() (bool, error)

Status

Renvoie l’état complet de l’enregistrement.

func (m *AutostartManager) Status() (AutostartStatus, error)

AutostartStatus :

Comportement selon la plateforme

Type=Application
Hidden=false
X-GNOME-Autostart-enabled=true
Exec=<executable> <arguments>

if err := app.Autostart.Enable(); err != nil {
    if errors.Is(err, application.ErrAutostartNotSupported) {
        // hide the toggle in the UI
        return
    }
    // real failure — surface it
}

Identifiant

Si Options.Identifier est vide, une valeur par défaut est dérivée du nom de votre application :

Les identifiants doivent correspondre à ^[A-Za-z0-9._-]+$ et ne pas dépasser 200 caractères. Le format DNS inversé est recommandé sous macOS (il correspond à la convention d’écriture des Labels de launchd).

Lorsque AutostartOptions.Identifier est remplacé, le même identifiant est réutilisé comme nom de valeur du Registre sous Windows et comme nom de fichier .desktop sous Linux. Une seule chaîne permet donc d’identifier l’enregistrement sur toutes les plateformes.

Détection des enregistrements obsolètes

Disable() et Status() localisent l’enregistrement en comparant le chemin de l’exécutable enregistré à os.Executable() (après résolution des éventuels liens symboliques), et non en recherchant l’identifiant. Cela signifie que :

• Vous pouvez modifier l’identifiant entre deux versions sans risque. L’ancien enregistrement reste détectable par Status() et est supprimé par Disable(), à condition que le chemin de l’exécutable reste identique.
• Une seconde copie de l’application située à un autre emplacement n’écrasera pas l’enregistrement de la première. Chaque emplacement du binaire est suivi indépendamment.
• Les installations utilisant des liens symboliques (Homebrew, Scoop) restent stables. filepath.EvalSymlinks est appliqué à os.Executable() avant la comparaison. Ainsi, une mise à niveau Homebrew qui remplace la cible ne laisse pas l’entrée orpheline.

Ce mécanisme ne couvre pas le cas suivant : si l’utilisateur déplace ou renomme le binaire vers un chemin sans rapport avec le précédent, l’ancien enregistrement devient orphelin (il pointe vers le fichier désormais absent). Les applications distribuées depuis un chemin d’installation stable n’ont pas à s’en préoccuper. Celles distribuées sous forme de binaires portables constitués d’un seul fichier devraient appeler Disable() avant de se déplacer elles-mêmes, ou toujours être lancées au moyen d’un lien symbolique stable.

Exemple

package main

import (
    "errors"

    "github.com/wailsapp/wails/v3/pkg/application"
)

func main() {
    app := application.New(application.Options{
        Name: "My App",
    })

    // Restore the user's preference on startup
    if userPrefersAutostart() {
        if err := app.Autostart.Enable(); err != nil {
            if !errors.Is(err, application.ErrAutostartNotSupported) {
                app.Logger.Error("autostart", "error", err)
            }
        }
    }

    app.Run()
}

Un exemple complet et exécutable comportant des boutons d’état, d’activation et de désactivation se trouve dans examples/autostart/.