Cartão ao vivo
Categoria: Eventos. Etiquetas: Saguões e recepção, Lojas, Notícias e anúncios, Eventos e locais.
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 |
|---|---|---|---|---|
calendars | array | ["world"] | maxItems: 11; uniqueItems: true | Quais conjuntos de ocasiões o cartão usa: mundial (Ano Novo, Dia dos Namorados, Páscoa, Halloween, Natal), cristão, ortodoxo, EUA, Canadá, Reino Unido, Austrália, lunar, judeu, islâmico e sul-asiático. |
occasion | string | "auto" | "auto", "new-years-day", "valentines-day", "st-patricks-day", "easter", "earth-day", "halloween", "christmas-eve", "christmas", "new-years-eve", "good-friday", "orthodox-christmas", "orthodox-easter", "mlk-day", "presidents-day", "mothers-day", "memorial-day", "juneteenth", "fathers-day", "independence-day", "labor-day", "veterans-day", "thanksgiving", "canada-day", "victoria-day", "thanksgiving-ca", "remembrance-day", "boxing-day", "mothering-sunday", "bonfire-night", "remembrance-sunday", "australia-day", "anzac-day", "fathers-day-au", "lunar-new-year", "lantern-festival", "dragon-boat", "mid-autumn", "rosh-hashanah", "passover", "hanukkah", "ramadan", "eid-al-fitr", "eid-al-adha", "islamic-new-year", "diwali", "vaisakhi" | auto seleciona a ocasião na temporada, ou a próxima. Um id mostra a saudação dessa ocasião em todos os dias. |
showUpcoming | boolean | true | Quando nada está na temporada, mostra a próxima ocasião com sua contagem regressiva. Off mostra a mensagem simples. | |
leadDays | integer, null | null | mínimo: 0; máximo: 60 | Quantos dias antes de uma ocasião sua saudação aparece. Vazio usa a introdução própria de cada ocasião. |
moonOffset | integer | 0 | mínimo: -2; máximo: 2 | Dias adicionados às datas do Ramadã e do Eid, para seguir a observação local da lua. |
timeZone | string, nulo | null | ||
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 |
|---|---|---|---|---|
message | string | "" | maxLength: 120 | Substitui a saudação da ocasião. Sem ocasião visível, é a mensagem do cartão (Bem-vindo quando vazio). |
note | string | "" | maxLength: 160 | Substitui a linha abaixo da saudação. |
signoff | string | "" | maxLength: 100 | Substitui a despedida (Com os melhores votos). |
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 greeting --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": "greeting",
"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:
{
"message": "",
"note": "",
"signoff": ""
}
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":{"message":"","note":"","signoff":""}}'