View on GitHub
FezData Structure Reference
FezData
public struct FezData : Content, ResponseEncodableUsed to return a FriendlyFez‘s data.
Returned by these methods, with members set to nil.
POST /api/v3/fez/ID/joinPOST /api/v3/fez/ID/unjoinGET /api/v3/fez/joinedGET /api/v3/fez/openGET /api/v3/fez/ownerPOST /api/v3/fez/ID/user/ID/addPOST /api/v3/fez/ID/user/ID/removePOST /api/v3/fez/ID/cancel
Returned by these methods, with members populated.
GET /api/v3/fez/IDPOST /api/v3/fez/createPOST /api/v3/fez/ID/postPOST /api/v3/fex/ID/post/ID/deleteSeeFezController.createHandler(_:data:),FezController.joinHandler(_:),FezController.unjoinHandler(_:),FezController.joinedHandler(_:)FezController.openhandler(_:),FezController.ownerHandler(_:),FezController.userAddHandler(_:),FezController.userRemoveHandler(_:),FezController.cancelHandler(_:).
-
The ID of the fez.
Declaration
Swift
var fezID: UUID -
The fez’s owner.
Declaration
Swift
var owner: UserHeader -
The title of the fez.
Declaration
Swift
var title: String -
A description of the fez.
Declaration
Swift
var info: String -
The starting time of the fez.
Declaration
Swift
var startTime: Date? -
The ending time of the fez.
Declaration
Swift
var endTime: Date? -
The 3 letter abbreviation for the active time zone at the time and place where the fez is happening.
Declaration
Swift
var timeZone: String? -
The timezone ID that the ship is going to be in when the fez occurs. Example: “America/New_York”.
Declaration
Swift
var timeZoneID: String? -
The location for the fez.
Declaration
Swift
var location: String? -
How many users are currently members of the fez. Can be larger than maxParticipants; which indicates a waitlist.
Declaration
Swift
var participantCount: Int -
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 -
The max number of people for the activity. Set by the host.
Declaration
Swift
var maxParticipants: Int -
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 -
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 -
FezData.MembersOnlyData returns data only available to participants in a Fez.
See moreDeclaration
Swift
public struct MembersOnlyData : Content, ResponseEncodable -
Will be nil if user is not a member of the fez (in the participant or waiting lists).
Declaration
Swift
var members: MembersOnlyData? -
Declaration
Swift
init(fez: FriendlyFez, owner: UserHeader) throws