EventData

public struct EventData : Content

Used to obtain an event’s details.

Returned by:

  • GET /api/v3/events
  • GET /api/v3/events/favorites

See EventController.eventsHandler(_:), EventController.favoritesHandler(_:).

Show on GitHub

  • The event’s ID. This is the Swiftarr database record for this event.

    Declaration

    Swift

    var eventID: UUID
    Show on GitHub
  • uid

    The event’s UID. This is the VCALENDAR/ICS File/sched.com identifier for this event–what calendar software uses to correllate whether 2 events are the same event.

    Declaration

    Swift

    var uid: String
    Show on GitHub

  • The event’s title.

    Declaration

    Swift

    var title: String
    Show on GitHub

  • A description of the event.

    Declaration

    Swift

    var description: String
    Show on GitHub

  • Starting time of the event

    Declaration

    Swift

    var startTime: Date
    Show on GitHub

  • Ending time of the event.

    Declaration

    Swift

    var endTime: Date
    Show on GitHub

  • The timezone that the ship is going to be in when the event occurs. Delivered as an abbreviation e.g. “EST”.

    Declaration

    Swift

    var timeZone: String
    Show on GitHub

  • The timezone ID that the ship is going to be in when the event occurs. Example: “America/New_York”.

    Declaration

    Swift

    var timeZoneID: String
    Show on GitHub

  • The location of the event.

    Declaration

    Swift

    var location: String
    Show on GitHub

  • The event category.

    Declaration

    Swift

    var eventType: String
    Show on GitHub

  • The last time data for this event was modified. Used for change management.

    Declaration

    Swift

    var lastUpdateTime: Date
    Show on GitHub

  • The event’s associated Forum.

    Declaration

    Swift

    var forum: UUID?
    Show on GitHub

  • Whether user has favorited event.

    Declaration

    Swift

    var isFavorite: Bool
    Show on GitHub

  • Makes an eventData.

    The startTime, endTime, and timeZone are the corrected Date values for the event, given the time zone the ship was/will be in at the event start time.

    Declaration

    Swift

    init(_ event: Event, isFavorite: Bool = false) throws
    Show on GitHub