AnnouncementCreateData

public struct AnnouncementCreateData : Content, Authorable
extension AnnouncementCreateData: RCFValidatable

structs in this file should only be used by Admin APIs, that is: API calls that require administrator access. For admins to create and edit Annoucements.

Show on GitHub

  • The text of the announcement

    Declaration

    Swift

    var text: String
    Show on GitHub

  • How long to display the announcement to users. User-level API route methods will only return this Announcement until this time. The given Date is interpreted as a floating time in the ship’s Port timezone.

    Declaration

    Swift

    var displayUntil: Date
    Show on GitHub

  • Author the announcement as this privileged account: “TwitarrTeam”, “THO”, or “admin”. nil, “”, “self”, or the caller’s own username means the caller. Checked server-side against the caller’s access level.

    Declaration

    Swift

    var postAsUser: String?
    Show on GitHub

  • Declaration

    Swift

    func runValidations(using decoder: ValidatingDecoder) throws
    Show on GitHub