セッションを終了する

現在の セッション を全参加者に対して終了するには、kickAll() ですべての参加者を退出させます。そのセッションの進行中の録画は停止し、セッションのステータスは ENDED になります。

セッションの終了は、ミーティングからの退出とは異なります。退出は現在の参加者だけを切断します。ほかの参加者が残っていれば、セッションは継続します。

1. ローカル参加者に、参加者を退出させる権限があることを確認します。

   const canEndSession = meeting.self.permissions.kickParticipant === true;
   
   if (!canEndSession) {
   	// Disable the "End meeting/session" control in your UI.
   	// You can also show a message to explain why the action is not available.
   }

   const canEndSession = meeting.self.permissions.kickParticipant === true;
   
   if (!canEndSession) {
   	// Disable the "End meeting/session" control in your UI.
   	// You can also show a message to explain why the action is not available.
   }

   const canEndSession = meeting.self.permissions.kickParticipant === true;
   
   if (!canEndSession) {
   	// Disable the "End meeting/session" control in your UI.
   	// You can also show a message to explain why the action is not available.
   }

   val canEndSession = meeting.localUser.permissions.host.canKickParticipant
   
   if (!canEndSession) {
       // Disable the "End meeting/session" control in your UI.
       // You can also show a message to explain why the action is not available.
   }

   let canEndSession = meeting.localUser.permissions.host.canKickParticipant
   
   if !canEndSession {
       // Disable the "End meeting/session" control in your UI.
       // You can also show a message to explain why the action is not available.
   }

   const canEndSession = meeting.self.permissions.kickParticipant === true;
   
   if (!canEndSession) {
   	// Disable the "End meeting/session" control in your UI.
   	// You can also show a message to explain why the action is not available.
   }

2. すべての参加者を退出させて、セッションを終了します。

   参加者に必要な権限がない場合、kickAll() はエラーコード 1201 の ClientError を投げます。

   try {
   	await meeting.participants.kickAll();
   } catch (err) {
   	if (err?.code === 1201) {
   		// The participant does not have permission to end the session.
   		// Update your UI to indicate that the action is not allowed.
   		return;
   	}
   	throw err;
   }

   参加者に必要な権限がない場合、kickAll() はエラーコード 1201 の ClientError を投げます。

   try {
   	await meeting.participants.kickAll();
   } catch (err) {
   	if (err?.code === 1201) {
   		// The participant does not have permission to end the session.
   		// Update your UI to indicate that the action is not allowed.
   		return;
   	}
   	throw err;
   }

   参加者に必要な権限がない場合、kickAll() はエラーコード 1201 の ClientError を投げます。

   try {
   	await meeting.participants.kickAll();
   } catch (err) {
   	if (err?.code === 1201) {
   		// The participant does not have permission to end the session.
   		// Update your UI to indicate that the action is not allowed.
   		return;
   	}
   	throw err;
   }

   参加者に必要な権限がない場合、kickAll() は HostError を返します。

   val error: HostError? = meeting.participants.kickAll()
   
   if (error != null) {
       when (error) {
           is HostError.KickPermissionDenied -> {
               // The participant does not have permission to end the session.
               // Update your UI to indicate that the action is not allowed.
           }
       }
   } else {
       // Successfully initiated session end
   }

   参加者に必要な権限がない場合、kickAll() は HostError を返します。

   let error: HostError? = meeting.participants.kickAll()
   
   if let error = error {
       switch error {
       case .kickPermissionDenied:
           // The participant does not have permission to end the session.
           // Update your UI to indicate that the action is not allowed.
           break
       default:
           break
       }
   } else {
       // Successfully initiated session end
   }

   参加者に必要な権限がない場合、kickAll() はエラーコード 1201 の ClientError を投げます。

   try {
   	await meeting.participants.kickAll();
   } catch (err) {
   	if (err?.code === 1201) {
   		// The participant does not have permission to end the session.
   		// Update your UI to indicate that the action is not allowed.
   		return;
   	}
   	throw err;
   }

3. セッション終了イベントをリッスンします。

   セッションが終了すると、全参加者がセッションから退出します。SDK は state が ended の roomLeft イベントを発行します。

   meeting.self.on("roomLeft", ({ state }) => {
   	if (state === "ended") {
   		// Update your UI to show that the meeting session has ended.
   	}
   });

   セッションが終了すると、全参加者がセッションから退出します。SDK は state が ended の roomLeft イベントを発行します。

   meeting.self.on("roomLeft", ({ state }) => {
   	if (state === "ended") {
   		// Update your UI to show that the meeting session has ended.
   	}
   });

   セッションが終了すると、全参加者がセッションから退出します。SDK は state が ended の roomLeft イベントを発行します。

   meeting.self.on("roomLeft", ({ state }) => {
   	if (state === "ended") {
   		// Update your UI to show that the meeting session has ended.
   	}
   });

   セッションが終了すると、全参加者がセッションから退出します。イベントリスナーを購読して、セッション終了を処理できます。

   meeting.addMeetingRoomEventListener(object : RtkMeetingRoomEventListener {
       override fun onMeetingEnded() {
           // Update your UI to show that the meeting session has ended.
       }
   })

   セッションが終了すると、全参加者がセッションから退出します。イベントリスナーを購読して、セッション終了を処理できます。

   // Implement the delegate method
   extension MeetingViewModel: RtkMeetingRoomEventListener {
     func onMeetingEnded() {
         // Update your UI to show that the meeting session has ended.
     }
   }
   
   meeting.addMeetingRoomEventListener(meetingRoomEventListener: self)

   セッションが終了すると、全参加者がセッションから退出します。SDK は state が ended の roomLeft イベントを発行します。

   meeting.self.on("roomLeft", ({ state }) => {
   	if (state === "ended") {
   		// Update your UI to show that the meeting session has ended.
   	}
   });

バックエンドから Kick all participants API ですべての参加者を退出させ、セッションを終了することもできます。

Kick all participants API メソッドを使うと、ミーティングのアクティブセッションからすべての参加者を退出させられます。

curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID/active-session/kick-all" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

meeting.ended を購読する webhook を登録します。RealtimeKit はセッション終了時にこのイベントを送信します。 通知の送信、レポートの生成、データベース上のセッション記録の更新など、バックエンドのワークフローを起動できます。

curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/webhooks" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Session ended webhook",
		"url": "<YOUR_WEBHOOK_URL>",
		"events": [
				"meeting.ended"
		]
	}'

セッションを終了しても、ミーティングは無効になりません。参加者は再度参加して、新しいセッションを開始できます。 参加者が再度参加して新しいセッションを開始できないようにするには、Update a meeting API で、ミーティングのステータスを INACTIVE に設定します。

curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID" \
	--request PATCH \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"status": "INACTIVE"
	}'

• Preset で、preset が権限をどう制御するかを確認します。
• ローカル参加者 で、ローカル参加者のルーム状態の取りうる値を確認します。