-
Declaration
Swift
func registerRoutes(_ app: Application) throws
-
categoryIDParamExtension methodDeclaration
Swift
var categoryIDParam: PathComponent { get } -
twarrtIDParamExtension methodDeclaration
Swift
var twarrtIDParam: PathComponent { get } -
forumIDParamExtension methodDeclaration
Swift
var forumIDParam: PathComponent { get } -
postIDParamExtension methodDeclaration
Swift
var postIDParam: PathComponent { get } -
fezIDParamExtension methodDeclaration
Swift
var fezIDParam: PathComponent { get } -
userIDParamExtension methodDeclaration
Swift
var userIDParam: PathComponent { get } -
eventIDParamExtension methodDeclaration
Swift
var eventIDParam: PathComponent { get } -
reportIDParamExtension methodDeclaration
Swift
var reportIDParam: PathComponent { get } -
modStateParamExtension methodDeclaration
Swift
var modStateParam: PathComponent { get } -
announcementIDParamExtension methodDeclaration
Swift
var announcementIDParam: PathComponent { get } -
imageIDParamExtension methodDeclaration
Swift
var imageIDParam: PathComponent { get } -
accessLevelParamExtension methodDeclaration
Swift
var accessLevelParam: PathComponent { get } -
alertWordParamExtension methodDeclaration
Swift
var alertWordParam: PathComponent { get } -
muteWordParamExtension methodDeclaration
Swift
var muteWordParam: PathComponent { get } -
boardgameIDParamExtension methodDeclaration
Swift
var boardgameIDParam: PathComponent { get } -
songIDParamExtension methodDeclaration
Swift
var songIDParam: PathComponent { get } -
mkSongIDParamExtension methodDeclaration
Swift
var mkSongIDParam: PathComponent { get } -
mkSnippetIDParamExtension methodDeclaration
Swift
var mkSnippetIDParam: PathComponent { get } -
streamPhotoParamExtension methodDeclaration
Swift
var streamPhotoParam: PathComponent { get } -
usernameParamExtension methodDeclaration
Swift
var usernameParam: PathComponent { get } -
scheduleLogIDParamExtension methodDeclaration
Swift
var scheduleLogIDParam: PathComponent { get } -
performerIDParamExtension methodDeclaration
Swift
var performerIDParam: PathComponent { get } -
personalEventIDParamExtension methodDeclaration
Swift
var personalEventIDParam: PathComponent { get } -
huntIDParamExtension methodDeclaration
Swift
var huntIDParam: PathComponent { get } -
puzzleIDParamExtension methodDeclaration
Swift
var puzzleIDParam: PathComponent { get } -
eventUIDParamExtension methodDeclaration
Swift
var eventUIDParam: PathComponent { get } -
feedbackParamExtension methodDeclaration
Swift
var feedbackParam: PathComponent { get } -
apiQuery(_:Extension method, asynchronousendpoint: query: method: defaultHeaders: passThroughQuery: encodeContent: beforeSend: ) Declaration
Swift
@discardableResult func apiQuery<EncodableContent: Encodable>( _ req: Request, endpoint: String, query: [URLQueryItem]? = nil, method: HTTPMethod = .GET, defaultHeaders: HTTPHeaders? = nil, passThroughQuery: Bool = true, encodeContent: EncodableContent, beforeSend: (inout ClientRequest) throws -> Void = { _ in } ) async throws -> ClientResponse -
apiQuery(_:Extension method, asynchronousendpoint: query: method: defaultHeaders: passThroughQuery: beforeSend: ) Call the Swiftarr API. This method pulls a user’s token from their session data and adds it to the API call. By default it also forwards URL query parameters from the Site-level request to the API-level request.
We used to calculate the API URL from the request Host headers. But this proved untenable prior to boat 2022 due to NATing, DNS, and multi-layer networking. It was decided to explicitly make this a setting instead.
Declaration
Swift
@discardableResult func apiQuery( _ req: Request, endpoint: String, query: [URLQueryItem]? = nil, method: HTTPMethod = .GET, defaultHeaders: HTTPHeaders? = nil, passThroughQuery: Bool = true, beforeSend: (inout ClientRequest) throws -> Void = { _ in } ) async throws -> ClientResponse -
getOpenRoutes(_:Extension methodfeature: path: ) Declaration
Swift
func getOpenRoutes(_ app: Application, feature: SwiftarrFeature? = nil, path: PathComponent...) -> RoutesBuilder -
getGlobalRoutes(_:Extension methodfeature: minAccess: path: ) Declaration
Swift
func getGlobalRoutes(_ app: Application, feature: SwiftarrFeature? = nil, minAccess: UserAccessLevel = .banned, path: PathComponent...) -> RoutesBuilder -
Declaration
Swift
func getPrivateRoutes(_ app: Application, feature: SwiftarrFeature? = nil, minAccess: UserAccessLevel = .banned, path: PathComponent..., overrideMinUserAccessLevel: Bool = false) -> RoutesBuilder -
dateFromW3DatetimeString(_:Extension method) Declaration
Swift
func dateFromW3DatetimeString(_ dateStr: String) -> Date? -
displayMarkdownFileContents(_:Extension method, asynchronousfilePath: agreeButtonDestination: ) Declaration
Swift
func displayMarkdownFileContents(_ req: Request, filePath: String, agreeButtonDestination: String? = nil) async throws -> View
View on GitHub