View on GitHub
QuartermasterData
public struct QuartermasterData : Content, ResponseEncodableUsed to return a QuartermasterItem‘s data.
Returned by:
GET /api/v3/quartermasterGET /api/v3/quartermaster/IDPOST /api/v3/quartermaster/createPOST /api/v3/quartermaster/ID/update
-
The item’s ID.
Declaration
Swift
var itemID: UUID -
Whether the owner has or needs the item.
Declaration
Swift
var category: QuartermasterCategory -
A short name/title for the item. Masked to a review notice when the item is quarantined.
Declaration
Swift
var itemName: String -
An optional longer description. Masked when quarantined.
Declaration
Swift
var itemDescription: String? -
An optional free-text pickup/exchange location. Masked when quarantined.
Declaration
Swift
var location: String? -
An optional filename for the item’s photo.
nilwhen there’s no photo, or when quarantined.Declaration
Swift
var image: String? -
The item’s creator.
nilwhenhideOwnerNameistrueand the viewer is neither the owner nor a moderator.Declaration
Swift
var owner: UserHeader? -
Whether the owner has chosen to hide their identity from other users.
Declaration
Swift
var hideOwnerName: Bool -
The item’s current moderation status.
Declaration
Swift
var moderationStatus: ContentModerationStatus -
The time of the item’s most recent modification.
Declaration
Swift
var lastModificationTime: Date
-
Declaration
Swift
init(item: QuartermasterItem, owner: UserHeader, showOwner: Bool, overrideQuarantine: Bool = false) throwsParameters
showOwnerWhether to reveal the real owner in this response. Should be
truewhen the viewer is the item’s owner, a moderator, orhideOwnerNameisfalse;falseotherwise.