Video calls resource

VideoCallAccessResourceCopy Anchor Link

class VideoCallAccessResource

Access to a video call. Reached through ovok.videoCalls.access.

ConstructorsCopy Anchor Link

VideoCallAccessResource.newCopy Anchor Link

VideoCallAccessResource(HttpClient _livekit)

Built by Ovok; use ovok.videoCalls.access instead.

MethodsCopy Anchor Link

VideoCallAccessResource.permissionCopy Anchor Link

Future<JsonMap> permission(String appointmentId)

Retrieves the caller's permission for the call.

Calls GET video-call/livekit/access-permission/{appointmentId}.

Returns Future<Map<String, dynamic>>.

VideoCallAccessResource.createGuestCopy Anchor Link

Future<JsonMap> createGuest(String appointmentId, JsonMap body)

Creates guest access to the call.

Calls POST video-call/livekit/guest-access/{appointmentId}.

Returns Future<Map<String, dynamic>>.

VideoCallAccessResource.createUserCopy Anchor Link

Future<JsonMap> createUser(String appointmentId)

Creates access to the call for the signed-in user.

Calls POST video-call/livekit/user-access/{appointmentId}.

Returns Future<Map<String, dynamic>>.

VideoCallAppointmentsResourceCopy Anchor Link

class VideoCallAppointmentsResource

Video call appointments. Reached through ovok.videoCalls.appointments.

ConstructorsCopy Anchor Link

VideoCallAppointmentsResource.newCopy Anchor Link

VideoCallAppointmentsResource(HttpClient _livekit)

Built by Ovok; use ovok.videoCalls.appointments instead.

MethodsCopy Anchor Link

VideoCallAppointmentsResource.listCopy Anchor Link

Future<List<JsonMap>> list([QueryParams params = const {}])

Lists appointments. Calls GET video-call/livekit/appointment with params.

Returns Future<List<Map<String, dynamic>>>.

VideoCallAppointmentsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates an appointment. Calls POST video-call/livekit/appointment.

Returns Future<Map<String, dynamic>>.

VideoCallAppointmentsResource.updateCopy Anchor Link

Future<JsonMap> update(String appointmentId, JsonMap body)

Updates an appointment.

Calls PUT video-call/livekit/appointment/{appointmentId}.

Returns Future<Map<String, dynamic>>.

VideoCallEmailsResourceCopy Anchor Link

class VideoCallEmailsResource

Video call emails. Reached through ovok.videoCalls.emails.

ConstructorsCopy Anchor Link

VideoCallEmailsResource.newCopy Anchor Link

VideoCallEmailsResource(HttpClient _livekit)

Built by Ovok; use ovok.videoCalls.emails instead.

MethodsCopy Anchor Link

VideoCallEmailsResource.inviteCopy Anchor Link

Future<JsonMap> invite(JsonMap body)

Sends a call invite email. Calls POST video-call/livekit/mail/invite.

Returns Future<Map<String, dynamic>>.

VideoCallEmailsResource.updateCopy Anchor Link

Future<JsonMap> update(JsonMap body)

Sends a call update email. Calls POST video-call/livekit/mail/update.

Returns Future<Map<String, dynamic>>.

VideoCallEmailsResource.cancelCopy Anchor Link

Future<JsonMap> cancel(JsonMap body)

Sends a call cancellation email. Calls POST video-call/livekit/mail/cancel.

Returns Future<Map<String, dynamic>>.

VideoCallsResourceCopy Anchor Link

class VideoCallsResource

LiveKit video calls and their appointments. Reached through ovok.videoCalls.

Every route is under video-call/livekit.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

VideoCallsResource.newCopy Anchor Link

VideoCallsResource(HttpClient http)

Built by Ovok; use ovok.videoCalls instead.

PropertiesCopy Anchor Link

VideoCallsResource.appointmentsCopy Anchor Link

final VideoCallAppointmentsResource appointments

Video call appointments.

VideoCallsResource.accessCopy Anchor Link

final VideoCallAccessResource access

Access to a call for users and guests.

VideoCallsResource.emailsCopy Anchor Link

final VideoCallEmailsResource emails

Call invite, update and cancel emails.

MethodsCopy Anchor Link

VideoCallsResource.notifyActiveCopy Anchor Link

Future<JsonMap> notifyActive(String appointmentId)

Notifies that the call for appointmentId is active.

Calls POST video-call/livekit/notification/active-call/{appointmentId}.

Returns Future<Map<String, dynamic>>.