# Video calls resource

Canonical page: https://docs.ovok.com/flutter-sdk/reference/ovok_sdk/video-calls-resource

{/* Generated by scripts/generate_reference.dart; do not edit. */}

## VideoCallAccessResource [#videocallaccessresource]

```dart
class VideoCallAccessResource
```

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

### Constructors [#constructors]

#### VideoCallAccessResource.new [#videocallaccessresourcenew]

```dart
VideoCallAccessResource(HttpClient _livekit)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `_livekit` | `HttpClient` | positional |  |

### Methods [#methods]

#### VideoCallAccessResource.permission [#videocallaccessresourcepermission]

```dart
Future<JsonMap> permission(String appointmentId)
```

Retrieves the caller's permission for the call.

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `appointmentId` | `String` | positional |  |

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

#### VideoCallAccessResource.createGuest [#videocallaccessresourcecreateguest]

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

Creates guest access to the call.

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `appointmentId` | `String` | positional |  |
| `body` | `JsonMap` | positional |  |

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

#### VideoCallAccessResource.createUser [#videocallaccessresourcecreateuser]

```dart
Future<JsonMap> createUser(String appointmentId)
```

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

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `appointmentId` | `String` | positional |  |

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


## VideoCallAppointmentsResource [#videocallappointmentsresource]

```dart
class VideoCallAppointmentsResource
```

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

### Constructors [#constructors-1]

#### VideoCallAppointmentsResource.new [#videocallappointmentsresourcenew]

```dart
VideoCallAppointmentsResource(HttpClient _livekit)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `_livekit` | `HttpClient` | positional |  |

### Methods [#methods-1]

#### VideoCallAppointmentsResource.list [#videocallappointmentsresourcelist]

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

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `params` | `QueryParams` | optional positional | `const {}` |

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

#### VideoCallAppointmentsResource.create [#videocallappointmentsresourcecreate]

```dart
Future<JsonMap> create(JsonMap body)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `body` | `JsonMap` | positional |  |

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

#### VideoCallAppointmentsResource.update [#videocallappointmentsresourceupdate]

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

Updates an appointment.

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `appointmentId` | `String` | positional |  |
| `body` | `JsonMap` | positional |  |

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


## VideoCallEmailsResource [#videocallemailsresource]

```dart
class VideoCallEmailsResource
```

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

### Constructors [#constructors-2]

#### VideoCallEmailsResource.new [#videocallemailsresourcenew]

```dart
VideoCallEmailsResource(HttpClient _livekit)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `_livekit` | `HttpClient` | positional |  |

### Methods [#methods-2]

#### VideoCallEmailsResource.invite [#videocallemailsresourceinvite]

```dart
Future<JsonMap> invite(JsonMap body)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `body` | `JsonMap` | positional |  |

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

#### VideoCallEmailsResource.update [#videocallemailsresourceupdate]

```dart
Future<JsonMap> update(JsonMap body)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `body` | `JsonMap` | positional |  |

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

#### VideoCallEmailsResource.cancel [#videocallemailsresourcecancel]

```dart
Future<JsonMap> cancel(JsonMap body)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `body` | `JsonMap` | positional |  |

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


## VideoCallsResource [#videocallsresource]

```dart
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.

### Constructors [#constructors-3]

#### VideoCallsResource.new [#videocallsresourcenew]

```dart
VideoCallsResource(HttpClient http)
```

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `http` | `HttpClient` | positional |  |

### Properties [#properties]

#### VideoCallsResource.appointments [#videocallsresourceappointments]

```dart
final VideoCallAppointmentsResource appointments
```

Video call appointments.

#### VideoCallsResource.access [#videocallsresourceaccess]

```dart
final VideoCallAccessResource access
```

Access to a call for users and guests.

#### VideoCallsResource.emails [#videocallsresourceemails]

```dart
final VideoCallEmailsResource emails
```

Call invite, update and cancel emails.

### Methods [#methods-3]

#### VideoCallsResource.notifyActive [#videocallsresourcenotifyactive]

```dart
Future<JsonMap> notifyActive(String appointmentId)
```

Notifies that the call for `appointmentId` is active.

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

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `appointmentId` | `String` | positional |  |

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