UserAccessLevel

public enum UserAccessLevel : String, Codable, Sendable
extension UserAccessLevel: Comparable
extension UserAccessLevel: RESPValueConvertible

All API endpoints are protected by a minimum user access level. This enum structure MUST match the values in CreateCustomEnums in SchemaCreation.swift as this enum is part of the database schema. This enum is also sent out in several Data Transfer Object types. Think very carefully about modifying these values.

Show on GitHub

  • A user account that has been banned. [cannot log in]

    Declaration

    Swift

    case banned
    Show on GitHub

  • A user account that has not yet been activated. [read-only, limited]

    Declaration

    Swift

    case unverified
    Show on GitHub

  • A .verified user account that has triggered Moderator review. [read-only]

    Declaration

    Swift

    case quarantined
    Show on GitHub

  • A user account that has been activated for full read-write access.

    Declaration

    Swift

    case verified
    Show on GitHub

  • A special class of account for registered API clients. [see ClientController]

    Declaration

    Swift

    case client
    Show on GitHub

  • An account whose owner is part of the Moderator Team.

    Declaration

    Swift

    case moderator
    Show on GitHub

  • Twitarr devs should have their accounts elevated to this level to help handle seamail to ‘twitarrteam’

    Declaration

    Swift

    case twitarrteam
    Show on GitHub
  • tho

    An account officially associated with Management, has access to all .moderator and a subset of .admin functions (the non-destructive ones). Can ban users.

    Declaration

    Swift

    case tho
    Show on GitHub

  • An Administrator account, unrestricted access.

    Declaration

    Swift

    case admin
    Show on GitHub

  • Declaration

    Swift

    init?(fromRawString str: String)
    Show on GitHub

  • Declaration

    Swift

    func visibleName() -> String
    Show on GitHub

  • Ensures that the access level of self grants at least the access level given in level. That is, UserAccessLevel.admin.hasAccess(.verified) returns true, while moderator.hasAccess(.admin) returns false. Although this currently uses > to test, the method could be expanded to non-hierarchy access types–and we may need to, as Clients can make calls that Moderators cannot, and vice versa.

    Declaration

    Swift

    func hasAccess(_ level: UserAccessLevel) -> Bool
    Show on GitHub

Capability Queries

  • Returns TRUE iff this user is allowed to post their own content and edit or delete content they created..

    Declaration

    Swift

    func canCreateContent() -> Bool
    Show on GitHub

  • Returns TRUE if this user is allowed to moderate others’ content. This includes editing text, removing images, and deleting posts. This capability does not include the ability to moderate users themselves.

    Declaration

    Swift

    func canEditOthersContent() -> Bool
    Show on GitHub

  • Returns TRUE if this user can change the access level of other users. The access level of Client users cannot be changed, and only admin level users can set other users’ access level to equal their own. For example moderator users can change user levels FROM any of [unverified, banned, quarantined, verified] TO any of [unverified, banned, quarantined, verified].

    Declaration

    Swift

    func canModerateUsers() -> Bool
    Show on GitHub
  • See more

    Declaration

    Swift

    public static func < (lhs: UserAccessLevel, rhs: UserAccessLevel) -> Bool
    Show on GitHub

  • Attempts to create a new instance of the conforming type based on the value represented by the RESPValue.

    Declaration

    Swift

    public init?(fromRESP value: RESPValue)

    Parameters

    value

    The RESPValue representation to attempt to initialize from.
    Show on GitHub

  • Creates a RESPValue representation of the conforming type’s value.

    Declaration

    Swift

    public func convertedToRESPValue() -> RESPValue
    Show on GitHub