Struct EventResource 

pub struct EventResource {

    pub id: EventId,
    pub created_by: PublicUserProfile,
    pub created_at: Timestamp,
    pub updated_by: PublicUserProfile,
    pub updated_at: Timestamp,
    pub title: EventTitle,
    pub description: EventDescription,
    pub room: EventRoomInfo,
    pub invitees_truncated: bool,
    pub invitees: Vec<EventInvitee>,
    pub is_time_independent: bool,
    pub is_all_day: Option<bool>,
    pub starts_at: Option<DateTimeTz>,
    pub ends_at: Option<DateTimeTz>,
    pub recurrence_pattern: RecurrencePattern,
    pub is_adhoc: bool,
    pub type_: EventType,
    pub invite_status: EventInviteStatus,
    pub is_favorite: bool,
    pub can_edit: bool,
    pub shared_folder: Option<SharedFolder>,
    pub streaming_targets: Vec<RoomStreamingTarget>,
    pub show_meeting_details: bool,
    pub training_participation_report: Option<TrainingParticipationReportParameterSet>,
}

Event Resource representation

Returned from GET /events/ and GET /events/{event_id}

Fields

id: EventId

ID of the event

created_by: PublicUserProfile

Public user profile of the user which created the event

created_at: Timestamp

Timestamp of the event creation

updated_by: PublicUserProfile

Public user profile of the user which last updated the event

updated_at: Timestamp

Timestamp of the last update

title: EventTitle

Title of the event

For display purposes

description: EventDescription

Description of the event

For display purposes

room: EventRoomInfo

All information about the room the event takes place in

invitees_truncated: bool

Flag which indicates if invitees contains all invites as far as known to the application May also be true if there are no invitees but no invitees were requested

invitees: Vec<EventInvitee>

List of event invitees and their invite status. Might not be complete, see invite_truncated

is_time_independent: bool

Is the event time independent?

Time independent events are not bound to any time but instead are constantly available to join

is_all_day: Option<bool>

Is the event an all day event

All-day events have no start/end time, they last the entire day(s)

starts_at: Option<DateTimeTz>

Start time of the event.

Omitted if is_time_independent is true

For events of type recurring the datetime contains the time of the first instance. The datetimes of subsequent recurrences are computed using the datetime of the first instance and its timezone.

ends_at: Option<DateTimeTz>

End time of the event.

Omitted if is_time_independent is true

For events of type recurring the datetime contains the time of the first instance. The datetimes of subsequent recurrences are computed using the datetime of the first instance and its timezone.

recurrence_pattern: RecurrencePattern

Recurrence pattern(s) for recurring events

May contain RRULE, EXRULE, RDATE and EXDATE strings

Requires type to be recurring

Contains a list of recurrence rules which describe the occurrences of the event. To get all event instances resolved use the GET /events/{event_id}/instances endpoint. Changing this field will always remove all exceptions for the event.

Allowed are RRULE, RDATE, EXRULE and EXDATE. The DTSTART and DTEND attributes are not allowed as their information is stored in the starts_at and ends_at fields.

is_adhoc: bool

Flag indicating whether the event is ad-hoc created.

type_: EventType

Type of event

Time independent events or events without recurrence are single while recurring events are recurring

invite_status: EventInviteStatus

The invite status of the current user for this event

is_favorite: bool

Is this event in the current user’s favorite list?

can_edit: bool

Can the current user edit this resource

shared_folder: Option<SharedFolder>

Information about the shared folder for the event

streaming_targets: Vec<RoomStreamingTarget>

The streaming targets of the room associated with the event

show_meeting_details: bool

Indicates whether meeting details should be provided. If absent, no meeting details are made available.

training_participation_report: Option<TrainingParticipationReportParameterSet>

The training participation report parameter set for the event.

When present, the training participation report will be started automatically in the meeting.

Trait Implementations

impl Clone for EventResource

fn clone(&self) -> EventResource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for EventResource

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for EventResource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventResource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExampleData for EventResource

fn example_data() -> Self

Get an example instance of the current datatype.

impl PartialEq for EventResource

fn eq(&self, other: &EventResource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EventResource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for EventResource

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Eq for EventResource

impl StructuralPartialEq for EventResource