Tarjeta en vivo
Categoría: Operaciones. Etiquetas: Alertas y estado, Números y métricas, Oficinas y lugares de trabajo.
Diseños
Esta tarjeta de pantalla completa llena toda la pantalla en modo horizontal o vertical y no se coloca como esquina, chip o tira.
Diseños: completo. Formularios: horizontal, vertical.
Diseños, temas y publicación de tarjetas. Explorar las tarjetas.
Datos y privacidad
Feed: screenrig.builds/v1.
Los documentos del feed llevan atribución de la fuente. El Player suministra el feed a la tarjeta.
Propiedades
Para tema, fondo, acento y posición, consulte Propiedades comunes.
Establezca las propiedades estáticas en los params de la tarjeta al crearla. Su documento de datos solo contiene propiedades dinámicas. Las filas anidadas describen el contenido de su propiedad principal.
Propiedades estáticas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
title | string | "Builds" | maxLength: 40 | |
branch | string | "" | maxLength: 60 | Muestra solo ejecuciones en esta sucursal; vacío muestra todas las sucursales. |
show | string | "all" | "all", "builds", "deploys" | |
staleMinutes | integer | 10 | mínimo: 1; máximo: 1440 | Los datos anteriores a esto muestran Actualizado hace N min. |
backgroundColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe el fondo y la placa de la tarjeta con un color plano ordenado por CSS. #RRGGBBAA suministra opacidad. background none tiene prioridad. |
textColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe los colores de texto principal y secundario. Los colores de acento y estado semántico mantienen sus roles. |
Propiedades dinámicas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
updatedAt | string | "" | maxLength: 40 | Instante ISO 8601 en que se tomaron las pipelines (solo almacén de datos; un feed lleva fetchedAt). |
pipelines | array | [] | maxItems: 60 | |
pipelines[].id | string | "" | maxLength: 60 | |
pipelines[].name | string | minLength: 1; maxLength: 60; Requerido | El repositorio o pipeline. | |
pipelines[].branch | string | "" | maxLength: 60 | |
pipelines[].kind | string | "build" | "build", "deploy" | |
pipelines[].environment | string | "" | maxLength: 30 | Dónde se despliega, por ejemplo producción. |
pipelines[].status | string | "" | maxLength: 24 | aprobado, fallado, en ejecución, en cola o cancelado. También se lee: éxito, exitoso, ok, verde, desplegado; fallo, error, roto, rojo, tiempo agotado; en progreso, construyendo, desplegando, iniciado; pendiente, esperando, programado; cancelado, omitido, abortado. Cualquier otra palabra se muestra en gris tal cual. |
pipelines[].startedAt | string | "" | maxLength: 40 | Instante ISO 8601 en que comenzó la corrida (corridas en cola: cuando se pusieron en cola). La duración de una pipeline en ejecución cuenta desde este instante. |
pipelines[].finishedAt | string | "" | maxLength: 40 | Instante ISO 8601 en que terminó la corrida. |
pipelines[].durationSeconds | integer | 0 | mínimo: 0; máximo: 8640000 | La duración de la corrida. Si se omite, es finishedAt menos startedAt. |
pipelines[].actor | string | "" | maxLength: 60 | Quién lo inició o activó. |
Ejemplo de lienzo
Guarde las propiedades estáticas como params.json y cree la tarjeta. El resultado incluye su id crd_.
{
"theme": "neomustard"
}
screenrig card create --type build-board --major 1 --file params.json
Agregue este elemento a los primitives de una página de la lista de reproducción, con ese id en lugar del del ejemplo. Publique la lista de reproducción y asigne una pantalla.
{
"id": "build-board",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Escribir datos en vivo
Escriba el documento en la tarjeta después de crearla y luego reemplácelo para actualizar la pantalla sin republicar. La tarjeta verifica cada escritura contra sus propiedades dinámicas y rechaza un documento que no acepta. Use el mismo proyecto que la lista de reproducción.
Guarde el documento como card-data.json. La CLI lee el documento en sí, sin envoltorio:
{
"updatedAt": "",
"pipelines": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
O llame a la API directamente. La API envuelve el mismo documento en un campo document. Un token de agente ya nombra su proyecto, por lo que no se envía encabezado de proyecto; si envía ScreenRig-Project, debe coincidir con el proyecto del token. Proporcione su autorización API a través del entorno; vea Autenticación 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":{"updatedAt":"","pipelines":[]}}'