Inicialização automática

Inicialização automática

app.Autostart registra seu aplicativo para ser iniciado automaticamente quando o usuário faz login. Ele seleciona o mecanismo nativo adequado para cada plataforma e resolve caminhos de instalação com links simbólicos (Homebrew, Scoop), para que os registros não deixem de funcionar quando o binário for atualizado.

O registro entra em vigor no próximo login, não imediatamente.

Início rápido

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

Registra o aplicativo para ser iniciado no login com as opções padrão.

func (m *AutostartManager) Enable() error

É seguro chamar Enable repetidamente — o registro é sobrescrito a cada vez, portanto, é correto chamá-lo em toda inicialização se você tiver armazenado a preferência do usuário.

EnableWithOptions

Faz o registro com opções personalizadas.

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

AutostartOptions:

Disable

Remove o registro de inicialização automática. Retorna nil se o aplicativo não estava registrado — a desativação é idempotente.

func (m *AutostartManager) Disable() error

IsEnabled

Informa se existe um registro. É rápido, pois não valida o caminho registrado.

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

Status

Retorna o estado completo do registro.

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

AutostartStatus:

Comportamento por plataforma

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
}

Identificador

Se Options.Identifier estiver vazio, um valor padrão será derivado do nome do aplicativo:

Os identificadores devem corresponder a ^[A-Za-z0-9._-]+$ e ter no máximo 200 caracteres. O formato DNS reverso é recomendado para o macOS (ele corresponde à forma como os Labels do launchd são convencionalmente escritos).

Quando AutostartOptions.Identifier é substituído, o mesmo identificador é reutilizado como nome do valor do Registro no Windows e como nome do arquivo .desktop no Linux, de modo que uma única string identifica o registro em todas as plataformas.

Detecção de registros obsoletos

Disable() e Status() localizam o registro comparando o caminho do executável registrado com os.Executable() (resolvido por meio de quaisquer links simbólicos), e não consultando o identificador. Isso significa que:

• É seguro alterar o identificador entre versões. O registro antigo ainda pode ser localizado por Status() e removido por Disable() — desde que o caminho do executável permaneça o mesmo.
• Uma segunda cópia do aplicativo em outro caminho não sobrescreverá o registro da primeira. Cada localização do binário é rastreada de forma independente.
• Instalações por links simbólicos (Homebrew, Scoop) permanecem estáveis. filepath.EvalSymlinks é aplicado a os.Executable() antes da comparação, portanto uma atualização do Homebrew que troca o destino não deixa a entrada órfã.

O que isso não abrange: se o usuário mover ou renomear o binário para um caminho não relacionado, o registro antigo ficará órfão (apontará para o arquivo que agora não existe). Aplicativos distribuídos em um caminho de instalação estável não precisam se preocupar com isso; aplicativos distribuídos como binários portáteis de arquivo único devem chamar Disable() antes de mover a si próprios ou sempre ser iniciados por meio de um link simbólico estável.

Exemplo

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()
}

Um exemplo completo e executável, com botões de status, ativação e desativação, está em examples/autostart/.