ライブカード
カテゴリ: オペレーション。タグ: アラートとステータス、数値と指標、オフィスと職場。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
フィード:screenrig.builds/v1。
フィードドキュメントは情報源の帰属を含みます。プレーヤーがカードにフィードを提供します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "Builds" | maxLength:40 | |
branch | string | "" | maxLength:60 | この支店の実行のみ表示します。空欄の場合はすべての支店を表示します。 |
show | string | "all" | "all", "builds", "deploys" | |
staleMinutes | integer | 10 | 最小値:1;最大値:1440 | これより古いデータは「N分前に更新」と表示されます。 |
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
updatedAt | string | "" | maxLength:40 | パイプラインが取得されたISO 8601時刻(データストアのみ。フィードはfetchedAtを運びます)。 |
pipelines | array | [] | maxItems:60 | |
pipelines[].id | string | "" | maxLength:60 | |
pipelines[].name | string | minLength:1;maxLength:60;必須 | リポジトリまたはパイプライン。 | |
pipelines[].branch | string | "" | maxLength:60 | |
pipelines[].kind | string | "build" | "build", "deploy" | |
pipelines[].environment | string | "" | maxLength:30 | デプロイ先、例えば本番環境。 |
pipelines[].status | string | "" | maxLength:24 | passed、failed、running、queued、cancelled。成功、成功済み、OK、緑、配信済み;失敗、エラー、故障、赤、タイムアウト;進行中、ビルド中、配信中、開始済み;保留、待機中、予定済み;キャンセル済み、スキップ済み、中止済み。その他の単語は指定通りグレー表示。 |
pipelines[].startedAt | string | "" | maxLength:40 | 実行が開始されたISO 8601時刻(キュー待ちの実行はキューに入った時刻)。実行中のパイプラインの継続時間はここから数えます。 |
pipelines[].finishedAt | string | "" | maxLength:40 | 実行が終了したISO 8601時刻。 |
pipelines[].durationSeconds | integer | 0 | 最小値:0;最大値:8640000 | ランの長さ。省略時はfinishedAtからstartedAtを引いた値です。 |
pipelines[].actor | string | "" | maxLength:60 | 誰が開始またはトリガーしたか。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type build-board --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "build-board",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"updatedAt": "",
"pipelines": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
またはAPIを直接呼び出します。APIは同じドキュメントをdocumentフィールドにラップします。エージェントトークンはすでにプロジェクト名を含むため、プロジェクトヘッダーは送信しません。ScreenRig-Projectを送信する場合はトークンのプロジェクトと一致する必要があります。API認証は環境変数で提供してください。詳細は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":[]}}'