Cartão ao vivo
Categoria: Operações. Tags: Reconhecimento, Alertas e status, Escritórios e locais de trabalho.
Layouts
Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.
Layouts: cheio. Formas: paisagem, retrato.
Layouts, temas e publicação de cartões. Veja os cartões.
Dados e privacidade
Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.
Propriedades
Para tema, fundo, destaque e posição, veja Propriedades comuns.
Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.
Propriedades estáticas
| Nome | Tipo | Padrão | Valores e limites | Descrição |
|---|---|---|---|---|
title | string | "Deal closed" | maxLength: 30 | O rótulo na celebração. |
currency | string | "$" | maxLength: 4 | O símbolo da moeda exibido antes dos valores. |
celebrateSec | integer | 30 | mínimo: 5; máximo: 600 | Quanto tempo uma nova vitória mantém a celebração antes do cartão se estabilizar. |
backgroundColor | string, nulo | null | padrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência. |
textColor | string, nulo | null | padrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis. |
Propriedades dinâmicas
| Nome | Tipo | Padrão | Valores e limites | Descrição |
|---|---|---|---|---|
target | number | mínimo: 0 | Meta de hoje em unidades principais; a visão consolidada mostra o progresso em direção a ela. | |
wins | array | [] | maxItems: 50 | Negócios fechados, em qualquer ordem; o mais novo por at é o vencedor exibido. Um vencedor com menos de celebrateSec de idade assume o cartão. |
wins[].id | string | "" | maxLength: 40 | Chaveia a vitória, para que uma já exibida não celebre novamente. |
wins[].name | string | minLength: 1; maxLength: 60; Obrigatório | Quem fechou o negócio. | |
wins[].team | string | "" | maxLength: 40 | |
wins[].photo | string | "" | maxLength: 120 | Uma referência de mídia à foto da pessoa; vazio mostra suas iniciais. |
wins[].deal | string | "" | maxLength: 100 | O nome do cliente ou do negócio. |
wins[].amount | number | 0 | mínimo: 0 | O valor do negócio em unidades principais. |
wins[].at | string | "" | maxLength: 40 | Quando o acordo foi fechado, um instante ISO 8601. |
wins[].note | string | "" | maxLength: 120 | Uma linha curta abaixo da oferta, como um produto ou termo. |
Exemplo de tela
Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.
{
"theme": "neomustard"
}
screenrig card create --type win-alert --major 1 --file params.json
Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.
{
"id": "win-alert",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Escrever dados ao vivo
Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.
Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:
{
"target": 1,
"wins": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da API.
curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"target":1,"wins":[]}}'