Referência

vssh.dialogos

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.

Os diálogos do sistema e o menu de contexto, desenhados pelo shell com os dados que o app manda.

Verbos

mostrar

vssh.dialogos.mostrar(mensagem, titulo)

Uma caixa de informação com um botão OK. A resposta chega quando a pessoa fecha a caixa.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog".

argumentotipoopcionalno fio
mensagemstringnãomessage
titulostringsimtitle

erro

vssh.dialogos.erro(mensagem, titulo)

A mesma caixa de mostrar, com o tom de erro.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog", variant: "error".

argumentotipoopcionalno fio
mensagemstringnãomessage
titulostringsimtitle

confirmar

vssh.dialogos.confirmar(mensagem, titulo, sim, perigo)

Uma pergunta com dois botões, Cancelar e o que confirma, que diz o verbo em sim ("Excluir", "Publicar"; "OK" quando não vem). Com perigo, o botão que confirma tem a cor de destruir e o foco abre no Cancelar. A caixa mostra o ícone e o nome do app em cima. A resposta é true só quando a pessoa confirmou; fechar a caixa vale como cancelar.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog", variant: "confirm".

argumentotipoopcionalno fio
mensagemstringnãomessage
titulostringsimtitle
simstringsimyes
perigobooleansimdanger

escolher

vssh.dialogos.escolher(mensagem, opcoes, titulo)

Uma pergunta com de duas a quatro respostas, uma por botão, na ordem dada. A resposta é o id da escolhida, ou null quando a pessoa fechou a caixa sem escolher. É a pergunta de "Salvar", "Não salvar" e "Cancelar", em que fechar a caixa não pode valer como nenhuma das duas primeiras.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog", variant: "choice".

argumentotipoopcionalno fio
mensagemstringnãomessage
opcoes{ id: string, rotulo: string, principal?: boolean }[]nãooptions
titulostringsimtitle

perguntar

vssh.dialogos.perguntar(mensagem, valor, titulo)

Um campo de texto de uma linha. A resposta é o que a pessoa escreveu, ou null quando ela cancelou.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog", variant: "prompt".

argumentotipoopcionalno fio
mensagemstringnãomessage
valorstringsimvalue
titulostringsimtitle

senha

vssh.dialogos.senha(mensagem, titulo)

Um campo de senha, com o texto escondido. A resposta é o valor digitado, ou null quando a pessoa cancelou. O valor chega ao app; para uma credencial que o app não deve ver, o caminho é segredos.pedir.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "dialog", variant: "password".

argumentotipoopcionalno fio
mensagemstringnãomessage
titulostringsimtitle

vssh.dialogos.menuDeContexto(x, y, itens, ortografia)

O menu de contexto do ambiente, montado com os itens que o app descreve: label, icon, id, danger, checked, disabled, separator, header e um nível de submenu. icon é o nome de um ícone do Tuff (sigma, table). x e y são do viewport do app, e o shell soma a posição da janela. A resposta é o id do item escolhido (o label, quando o item não tem id), e null quando a pessoa fechou sem escolher. ortografia põe na frente as sugestões do corretor para a palavra errada do clique, e quem o passa é vssh.dialogos.menuDoEvento, do runtime: ele só vale num contextmenu que o app deixou sem cancelar, e o runtime sabe quando o ambiente o atende. A escolha de uma sugestão troca a palavra no campo e responde null.

Responde: uma promessa, com prazo de 10 min (ritmo humano, a resposta depende de uma pessoa). Num hiperlink: vale. No fio: type: "context-menu".

argumentotipoopcionalno fio
xnumbernãox
ynumbernãoy
itensobject[]nãoitems
ortografiabooleansimspelling

Eventos

ortografia

vssh.dialogos.ao('ortografia', cb)

Se o menu de contexto deste ambiente traz a correção ortográfica de um campo editável. Chega no load da janela, e só no cliente de desktop. O SDK já o usa em vssh.dialogos.menuDoEvento, que deixa o contextmenu passar quando ele é true.

campotipoopcionalno fio
noMenubooleannãoinMenu

Num hiperlink: chega. No fio: type: "spelling-menu".