Referência

vssh.configuracoes

Página gerada da tabela da ponte (api/abi.json) pelo canal de publicação do sistema. Uma mudança se faz na fonte, vssh-client/js/app/abi.js do vssh-sso.

A seção que o app traz a Configurações do ambiente (contributes.settings). Um app que a declara opcional (contributes.settingsOptIn) a liga e desliga daqui, de dentro dele; a escolha é por usuário e acompanha a pessoa.

Verbos

verboresponde
vssh.configuracoes.ligada()sim, em até 5 s
vssh.configuracoes.ligar(ligado)sim, em até 5 s
vssh.configuracoes.abrir()sim, em até 5 s

ligada

vssh.configuracoes.ligada()

Se a seção deste app aparece em Configurações, em ligada, e se ela é opcional, em opcional. Um app sem settingsOptIn lê ligada: true sempre.

Responde: uma promessa, com prazo de 5 s (ritmo rapido, a resposta não depende de uma pessoa). Num hiperlink: recusado. A seção de um app em Configurações roda o script dele na origem do shell. No fio: type: "settings-section", op: "get".

Sem argumentos.

ligar

vssh.configuracoes.ligar(ligado)

Liga (true) ou desliga (false) a seção deste app em Configurações, e responde o mesmo que ligada. Só faz efeito num app com settingsOptIn; nos outros a seção existe sempre, e a resposta diz isso.

Responde: uma promessa, com prazo de 5 s (ritmo rapido, a resposta não depende de uma pessoa). Num hiperlink: recusado. A seção de um app em Configurações roda o script dele na origem do shell. No fio: type: "settings-section", op: "set".

argumentotipoopcionalno fio
ligadobooleannãoligado

abrir

vssh.configuracoes.abrir()

Abre Configurações na seção deste app. Com a seção desligada, ou antes de ela ter sido carregada, abre Configurações no índice; a resposta traz em secao o id da seção aberta, ou null.

Responde: uma promessa, com prazo de 5 s (ritmo rapido, a resposta não depende de uma pessoa). Num hiperlink: recusado. A seção de um app em Configurações roda o script dele na origem do shell. No fio: type: "settings-section", op: "open".

Sem argumentos.

Eventos

Este espaço não declara eventos; vssh.configuracoes.ao() recusa qualquer nome.