-
Declaration
Swift
func registerRoutes(_ app: Application) throws
-
categoryIDParam
Extension methodDeclaration
Swift
var categoryIDParam: PathComponent { get }
-
twarrtIDParam
Extension methodDeclaration
Swift
var twarrtIDParam: PathComponent { get }
-
forumIDParam
Extension methodDeclaration
Swift
var forumIDParam: PathComponent { get }
-
postIDParam
Extension methodDeclaration
Swift
var postIDParam: PathComponent { get }
-
fezIDParam
Extension methodDeclaration
Swift
var fezIDParam: PathComponent { get }
-
userIDParam
Extension methodDeclaration
Swift
var userIDParam: PathComponent { get }
-
eventIDParam
Extension methodDeclaration
Swift
var eventIDParam: PathComponent { get }
-
reportIDParam
Extension methodDeclaration
Swift
var reportIDParam: PathComponent { get }
-
modStateParam
Extension methodDeclaration
Swift
var modStateParam: PathComponent { get }
-
announcementIDParam
Extension methodDeclaration
Swift
var announcementIDParam: PathComponent { get }
-
imageIDParam
Extension methodDeclaration
Swift
var imageIDParam: PathComponent { get }
-
accessLevelParam
Extension methodDeclaration
Swift
var accessLevelParam: PathComponent { get }
-
alertWordParam
Extension methodDeclaration
Swift
var alertWordParam: PathComponent { get }
-
muteWordParam
Extension methodDeclaration
Swift
var muteWordParam: PathComponent { get }
-
boardgameIDParam
Extension methodDeclaration
Swift
var boardgameIDParam: PathComponent { get }
-
songIDParam
Extension methodDeclaration
Swift
var songIDParam: PathComponent { get }
-
mkSongIDParam
Extension methodDeclaration
Swift
var mkSongIDParam: PathComponent { get }
-
mkSnippetIDParam
Extension methodDeclaration
Swift
var mkSnippetIDParam: PathComponent { get }
-
streamPhotoParam
Extension methodDeclaration
Swift
var streamPhotoParam: PathComponent { get }
-
usernameParam
Extension methodDeclaration
Swift
var usernameParam: PathComponent { get }
-
scheduleLogIDParam
Extension methodDeclaration
Swift
var scheduleLogIDParam: PathComponent { get }
-
performerIDParam
Extension methodDeclaration
Swift
var performerIDParam: PathComponent { get }
-
personalEventIDParam
Extension methodDeclaration
Swift
var personalEventIDParam: 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?