ClientApp

final class ClientApp : Model, @unchecked Sendable

A client application for Twitarr that we suggest users download. Shown in the web UI’s “Client Apps” page and returned by GET /api/v3/admin/clients.

See

See Also: ClientAppData the DTO for returning info on ClientApps.

See

See Also: ClientAppUploadData the DTO for mutating ClientApps.

See

See Also: CreateClientAppSchema the Migration for creating the ClientApp table in the database.

Show on GitHub

schema
Declaration
Swift

static let schema: String
Show on GitHub

Properties

id
The client app’s ID.
Declaration
Swift

@ClientApp .ID var id: UUID? { get set }
Show on GitHub
name
Display name of the app.
Declaration
Swift

@ClientApp .Field var name: String { get set }
Show on GitHub
appDescription
A short description of the app.
Declaration
Swift

@ClientApp .Field var appDescription: String { get set }
Show on GitHub
image
Filename of the app’s icon in the image store.
Declaration
Swift

@ClientApp .OptionalField var image: String? { get set }
Show on GitHub


                    
                    
                    developer

Who builds the app.

Declaration

Swift

@ClientApp
.Field var developer: String { get set }

Show on GitHub

sortName
Used to order apps in lists.
Declaration
Swift

@ClientApp .Field var sortName: String { get set }
Show on GitHub
links
One entry per platform the app is available on. The app’s platforms are derived from this.
Declaration
Swift

@ClientApp .Field var links: [ClientAppLink] { get set }
Show on GitHub
swiftarrClient
Optional linkage to one of the known SwiftarrClientApp values. Not shown to users.
Declaration
Swift

@ClientApp .OptionalField var swiftarrClient: SwiftarrClientApp? { get set }
Show on GitHub


                    
                    
                    createdAt

Declaration

Swift

@ClientApp
.Timestamp var createdAt: Date? { get set }

Show on GitHub


                    
                    
                    updatedAt

Declaration

Swift

@ClientApp
.Timestamp var updatedAt: Date? { get set }

Show on GitHub

Initialization

init()
Declaration
Swift

init()
Show on GitHub


                    
                    
                    init(name:description:image:developer:sortName:links:swiftarrClient:)

Declaration

Swift

init(name: String, description: String, image: String?, developer: String, sortName: String? = nil,
		links: [ClientAppLink], swiftarrClient: SwiftarrClientApp? = nil)

Show on GitHub


                    
                    
                    platforms

Declaration

Swift

var platforms: [ClientAppPlatform] { get }

Show on GitHub