ライブカード
カテゴリ: 学校。タグ: 学校とキャンパス、リーダーボードと順位、チャートとゲージ、表彰。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
賞はハウス名を示し、生徒名は示しません。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "House points" | maxLength:40 | |
awardCount | integer | 5 | 最小値:1;最大値:8 | フルレイアウトにリストされる最近の受賞数。 |
hour12 | boolean | true | ||
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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
houses | array | [] | minItems:0;maxItems:8 | ハウスとそのポイント合計です。順位、バーの高さ、リーダーは合計値から決まります。 |
houses[].name | string | minLength:1;maxLength:24;必須 | ||
houses[].points | integer | 最小値:0;最大値:999999;必須 | ||
houses[].color | string | パターン:"^#[0-9A-Fa-f]{6}$" | ハウスの色を#RRGGBB形式で指定します。指定がなければテーマから色を取得します。 | |
awards | array | [] | minItems:0;maxItems:40 | 最新の賞は時間順に新しいものから。賞は学生ではなくハウスの名前を示します。 |
awards[].house | string | minLength:1;maxLength:24;必須 | ハウスからのハウス名。 | |
awards[].points | integer | 最小値:1;最大値:999;必須 | ||
awards[].reason | string | "" | maxLength:80 | なぜポイントが与えられたのか、例:新しい友達を助けた。 |
awards[].at | string | "" | maxLength:40 | 受賞のISO 8601瞬間。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type house-points --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "house-points",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"houses": [],
"awards": []
}
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":{"houses":[],"awards":[]}}'