名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
仮想イベントの抽象基本型を表します。 virtualEventTownhall と virtualEventWebinar の基本の種類。
エンティティ から継承します。
ヒント
これは抽象型であり、直接使用することはできません。 代わりに派生型 virtualEventTownhall または virtualEventWebinar を使用してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| 外部イベント情報を設定する | なし | externalEventId を設定して、外部イベント情報を virtualEventTownhall または virtualEventWebinar にリンクします。 ] |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 容量 | 整数 | タウン ホールの予想出席者数を表します。 |
| createdBy | communicationsIdentitySet | 仮想イベントの作成者の ID 情報。 virtualEvent から継承されます。 |
| 説明 | itemBody | 仮想イベントの説明。 |
| displayName | 文字列 | 仮想イベントの表示名。 |
| endDateTime | dateTimeTimeZone | 仮想イベントの終了時刻。 timeZone プロパティは、Windows で現在サポートされている任意のタイム ゾーンに設定できます。 PowerShell を使用して使用可能なすべてのタイム ゾーンを取得する方法の詳細については、「 Get-TimeZone」を参照してください。 |
| externalEventInformation | virtualEventExternalInformation コレクション | 仮想イベントの外部情報。 イベントの主催者または共同開催者に対してのみ返されます。それ以外の場合は、 null。 |
| id | 文字列 | 仮想イベントの一意識別子。 エンティティから継承 されます。 |
| isRegistrationRequired | ブール型 | 仮想イベントの出席者の登録が有効になっているかどうかを示します。 |
| settings | virtualEventSettings | 仮想イベントの設定。 |
| startDateTime | dateTimeTimeZone | 仮想イベントの開始時刻。 timeZone プロパティは、Windows で現在サポートされている任意のタイム ゾーンに設定できます。 PowerShell を使用して使用可能なすべてのタイム ゾーンを取得する方法の詳細については、「 Get-TimeZone」を参照してください。 |
| status | virtualEventStatus | 仮想イベントの状態。 使用可能な値: draft、published、canceled、unknownFutureValue。 |
注:
注: isRegistrationRequired プロパティは、仮想イベントが登録ワークフローを使用するかどうかを制御します。
isRegistrationRequired が false に設定されている場合でも、登録関連の API を呼び出すことができます。 ただし、これらの呼び出しでは、完全登録エクスペリエンスはトリガーされません。 代わりに、カレンダーに追加アクションとして動作し、出席者は登録プロセスを完了しなくてもカレンダーにイベントを追加できます。
ウェビナーの場合、登録は既定で有効になっています (isRegistrationRequired = true)。
タウン ホールの場合、登録は既定では有効になっていません。 タウン ホールに登録が必要な場合は、開催者は仮想イベントを構成するときに明示的に isRegistrationRequired を true に設定する必要があります。
これにより、登録関連の API で、完全な登録ワークフローと出席者の登録エクスペリエンスが呼び出されます。
virtualEventStatus 値
| 値 | 説明 |
|---|---|
| 下書き | 仮想イベントは下書きであり、開催者だけに表示されます。 |
| 公開済み | 開催者が仮想イベントを公開し、対象ユーザーに表示されます。 |
| 取り消し | 開催者が仮想イベントを取り消しました。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| 発表者 | virtualEventPresenter コレクション | 仮想イベントの発表者。 |
| sessions | virtualEventSession コレクション | 仮想イベントのセッション。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.virtualEvent",
"capacity": "Integer",
"createdBy": {"@odata.type": "microsoft.graph.communicationsIdentitySet"},
"description": {"@odata.type": "microsoft.graph.itemBody"},
"displayName": "String",
"endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"externalEventInformation" : [{"@odata.type": "microsoft.graph.virtualEventExternalInformation"}],
"id": "String (identifier)",
"isRegistrationRequired": "Boolean",
"settings": {"@odata.type": "microsoft.graph.virtualEventSettings"},
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"status": "String"
}