FezData

public struct FezData : Content, ResponseEncodable

Used to return a FriendlyFez‘s data.

Returned by these methods, with members set to nil.

  • POST /api/v3/fez/ID/join
  • POST /api/v3/fez/ID/unjoin
  • GET /api/v3/fez/joined
  • GET /api/v3/fez/open
  • GET /api/v3/fez/owner
  • POST /api/v3/fez/ID/user/ID/add
  • POST /api/v3/fez/ID/user/ID/remove
  • POST /api/v3/fez/ID/cancel

Returned by these methods, with members populated.

Show on GitHub

  • The ID of the fez.

    Declaration

    Swift

    var fezID: UUID
    Show on GitHub

  • The fez’s owner.

    Declaration

    Swift

    var owner: UserHeader
    Show on GitHub

  • The FezType .label of the fez.

    Declaration

    Swift

    var fezType: FezType
    Show on GitHub

  • The title of the fez.

    Declaration

    Swift

    var title: String
    Show on GitHub

  • A description of the fez.

    Declaration

    Swift

    var info: String
    Show on GitHub

  • The starting time of the fez.

    Declaration

    Swift

    var startTime: Date?
    Show on GitHub

  • The ending time of the fez. If startTime specified, no more than 24 hours after the startTime since per Chall that makes iCal export get weird.

    Declaration

    Swift

    var endTime: Date?
    Show on GitHub

  • The 3 letter abbreviation for the active time zone at the time and place where the fez is happening.

    Declaration

    Swift

    var timeZone: String?
    Show on GitHub

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

    Declaration

    Swift

    var timeZoneID: String?
    Show on GitHub

  • The location for the fez.

    Declaration

    Swift

    var location: String?
    Show on GitHub

  • How many users are currently members of the fez. Can be larger than maxParticipants; which indicates a waitlist.

    Declaration

    Swift

    var participantCount: Int
    Show on GitHub

  • The min number of people for the activity. Set by the host. Fezzes may?? auto-cancel if the minimum participant count isn’t met when the fez is scheduled to start.

    Declaration

    Swift

    var minParticipants: Int
    Show on GitHub

  • The max number of people for the activity. Set by the host.

    Declaration

    Swift

    var maxParticipants: Int
    Show on GitHub

  • TRUE if the fez has been cancelled by the owner. Cancelled fezzes should display CANCELLED so users know not to show up, but cancelled fezzes are not deleted.

    Declaration

    Swift

    var cancelled: Bool
    Show on GitHub

  • The most recent of: Creation time for the fez, time of the last post (may not exactly match post time), user add/remove, or update to fezzes’ fields.

    Declaration

    Swift

    var lastModificationTime: Date
    Show on GitHub

  • FezData.MembersOnlyData returns data only available to participants in a Fez.

    See more

    Declaration

    Swift

    public struct MembersOnlyData : Content, ResponseEncodable
    Show on GitHub

  • Will be nil if user is not a member of the fez (in the participant or waiting lists).

    Declaration

    Swift

    var members: MembersOnlyData?
    Show on GitHub

  • Declaration

    Swift

    init(fez: FriendlyFez, owner: UserHeader) throws
    Show on GitHub