Conferences#

ConferencesRoot#

The data room’s conferences-root

message VideoConferencesRoot {
 string id = 1;
 string dataroom_id = 2;
 string name = 3;
 string type = 4;
 string document_class = 5;
 string author = 6;
 string title = 7;
 string path = 8;
 string version = 9;
 google.protobuf.Timestamp creation_date = 10;
 google.protobuf.Timestamp modification_date = 11;
 string icon = 12;
 uint32 num_children = 13; // collections only => subDocs
 EffectivePermission effective_permission = 14;
 ItemType item_type = 31;
}

Field

Type

Description

id

string

dataroom_id

string

name

string

type

string

author

string

title

string

path

string

version

string

creation_date

google.protobuf.Timestamp

modification_date

google.protobuf.Timestamp

icon

string

num_children

uint32

Collections only -> subDocs

effective_permission

EffectivePermission

item_type

ItemType

VideoConference#

One conference entry

message VideoConference {
 string id = 1;
 string dataroom_id = 2;
 string name = 3;
 string type = 4;
 string document_class = 5;
 string author = 6;
 string title = 7;
 string description = 9;
 google.protobuf.Timestamp creation_date = 10;
 google.protobuf.Timestamp modification_date = 11;
 string icon = 12;
 EffectivePermission effective_permission = 14;
 repeated ExternalParticipant external_participants = 15;
 repeated UserOrGroup internal_participants = 16;
 optional bool inform_internal_participants = 17;
 optional bool inform_external_participants = 18;
 optional UserOrGroup responsible_user = 19;
 optional User creator = 20;
 optional string rrule = 21;
 google.protobuf.Timestamp access_from = 32;
 google.protobuf.Timestamp access_to = 33;
 ItemType item_type = 31;
}

Field

Type

Description

id

string

dataroom_id

string

name

string

type

string

document_class

string

author

string

title

string

description

string

creation_date

google.protobuf.Timestamp

modification_date

google.protobuf.Timestamp

effective_permission

EffectivePermission

external_participants

array of ExternalParticipant

internal_participants

array of UserOrGroup

inform_internal_participants

bool

optional

inform_external_participants

bool

optional

responsible_user

UserOrGroup

optional

creator

User

optional

rrule

string

optional

access_from

google.protobuf.Timestamp

access_to

google.protobuf.Timestamp

item_type

ItemType

ExternalParticipant#

External Participant

message ExternalParticipant {
 optional Salutation salutation = 1;
 string first_name = 5;
 string last_name = 6;
 string email = 9;
 optional string company = 36;
 optional Language language = 13;
 optional string link = 14;
}

Field

Type

Description

salutation

Salutation

optional

first_name

string

last_name

string

email

string

company

string

optional

language

Language

optional

link

string

optional

SettingsEntryAsExternalParticipant#

One single setting with value as external participant

message SettingsEntryAsExternalParticipant {
 // protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
 repeated ExternalParticipant value = 1;
 optional bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field

Type

Description

value

array of ExternalParticipant

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

SettingsEntryAsInternalParticipant#

One single setting with value as internal participant

message SettingsEntryAsInternalParticipant {
 // protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
 repeated UserOrGroup value = 1;
 optional bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field

Type

Description

value

UserOrGroup

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

SettingsEntryAsUser#

One setting with value as responsible user

message SettingsEntryAsUser {
 User value = 1;
 optional bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field

Type

Description

value

User

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

VideoConferenceProperties#

Properties of a video conference

message VideoConferenceProperties {
 string id = 1;
 string dataroom_id = 2;
 string name = 3;
 string type = 4;
 string document_class = 5;
 SettingsEntryAsString title = 7;
 SettingsEntryAsString description = 9;
 EffectivePermission effective_permission = 14;
 SettingsEntryAsExternalParticipant external_participants = 15;
 SettingsEntryAsInternalParticipant internal_participants = 16;
 SettingsEntryAsBool inform_internal_participants = 17;
 SettingsEntryAsBool inform_external_participants = 18;
 SettingsEntryAsUser responsible_user = 19;
 SettingsEntryAsDate access_from = 32;
 SettingsEntryAsDate access_to = 33;
 SettingsEntryAsString rrule = 34;
 ItemType item_type = 31;
}

Field

Type

Description

id

string

dataroom_id

string

name

string

type

string

document_class

string

title

SettingsEntryAsString

description

SettingsEntryAsString

effective_permission

EffectivePermission

extrernal_participants

SettingsEntryAsExternalParticipant

internal_participants

SettingsEntryAsExternalParticipant

inform_internal_participants

SettingsEntryAsBool

inform_external_participants

SettingsEntryAsBool

responsible_user

SettingsEntryAsUser

access_from

SettingsEntryAsDate

access_to

SettingsEntryAsDate

rrule

SettingsEntryAsString

item_type

ItemType