ライブカード
カテゴリ: 学校。タグ: 学校とキャンパス、チャートとゲージ、数値と指標。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
カウントのみで、名前は表示しません。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
goal | integer | 95 | 最小値:1;最大値:100 | クラスまたは学校が達成すべき出席率の割合。 |
showDate | boolean | true | ||
hour12 | boolean | false | ||
timeZone | 文字列、null | null | ||
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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "Attendance today" | maxLength:40 | |
classes | array | [] | minItems:0;maxItems:16 | 今日のクラス別出席状況:登録者数に対して何人が出席しているか。未報告のクラスは出席者数に含みません。人数のみで名前は表示しません。 |
classes[].name | string | minLength:1;maxLength:28;必須 | ||
classes[].enrolled | integer | 最小値:1;最大値:9999;必須 | ||
classes[].present | integer | 最小値:0;最大値:9999 | 本日ここにいます。不在:クラスはまだ報告していません。 | |
classes[].streak | integer | 0 | 最小値:0;最大値:999 | 目標以上を達成した連続日数です。 |
classes[].reportedAt | string | "" | maxLength:40 | このクラスのカウントが最後に変化した時刻、ISO 8601形式です。Primetimeはこの時刻からクラスの100パーセント瞬間を再生します。 |
classes[].prevPresent | integer | 最小値:0;最大値:9999 | 変更前のここから;その瞬間のリングがここから満たされます。 | |
schoolStreak | integer | 0 | 最小値:0;最大値:999 | 学校全体が目標以上を達成した連続日数です。 |
takenAt | string | "" | maxLength:40 | 出席が取られたISO 8601瞬間。空欄は時間なし表示。 |
schoolMetAt | string | "" | maxLength:40 | 学校全体が目標を達成した時刻、ISO 8601形式です。Primetimeはこの時刻から全スクリーンで「GOAL MET」瞬間を再生します。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type attendance --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "attendance",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"title": "Attendance today",
"classes": [],
"schoolStreak": 0,
"takenAt": "",
"schoolMetAt": ""
}
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":{"title":"Attendance today","classes":[],"schoolStreak":0,"takenAt":"","schoolMetAt":""}}'