APIRouteCollection

protocol APIRouteCollection

Show on GitHub


                    
                    
                    registerRoutes(_:)

Declaration

Swift

func registerRoutes(_ app: Application) throws

Show on GitHub

categoryIDParam Extension method
Declaration
Swift

var categoryIDParam: PathComponent { get }
Show on GitHub
twarrtIDParam Extension method
Declaration
Swift

var twarrtIDParam: PathComponent { get }
Show on GitHub
forumIDParam Extension method
Declaration
Swift

var forumIDParam: PathComponent { get }
Show on GitHub
postIDParam Extension method
Declaration
Swift

var postIDParam: PathComponent { get }
Show on GitHub
fezIDParam Extension method
Declaration
Swift

var fezIDParam: PathComponent { get }
Show on GitHub
fezPostIDParam Extension method
Declaration
Swift

var fezPostIDParam: PathComponent { get }
Show on GitHub
userIDParam Extension method
Declaration
Swift

var userIDParam: PathComponent { get }
Show on GitHub
eventIDParam Extension method
Declaration
Swift

var eventIDParam: PathComponent { get }
Show on GitHub
reportIDParam Extension method
Declaration
Swift

var reportIDParam: PathComponent { get }
Show on GitHub
modStateParam Extension method
Declaration
Swift

var modStateParam: PathComponent { get }
Show on GitHub
announcementIDParam Extension method
Declaration
Swift

var announcementIDParam: PathComponent { get }
Show on GitHub
alertwordParam Extension method
Declaration
Swift

var alertwordParam: PathComponent { get }
Show on GitHub
mutewordParam Extension method
Declaration
Swift

var mutewordParam: PathComponent { get }
Show on GitHub
searchStringParam Extension method
Declaration
Swift

var searchStringParam: PathComponent { get }
Show on GitHub
dailyThemeIDParam Extension method
Declaration
Swift

var dailyThemeIDParam: PathComponent { get }
Show on GitHub
accessLevelParam Extension method
Declaration
Swift

var accessLevelParam: PathComponent { get }
Show on GitHub
boardgameIDParam Extension method
Declaration
Swift

var boardgameIDParam: PathComponent { get }
Show on GitHub
songIDParam Extension method
Declaration
Swift

var songIDParam: PathComponent { get }
Show on GitHub
mkSongIDParam Extension method
Declaration
Swift

var mkSongIDParam: PathComponent { get }
Show on GitHub
mkSnippetIDParam Extension method
Declaration
Swift

var mkSnippetIDParam: PathComponent { get }
Show on GitHub
userRoleParam Extension method
Declaration
Swift

var userRoleParam: PathComponent { get }
Show on GitHub
phonecallParam Extension method
Declaration
Swift

var phonecallParam: PathComponent { get }
Show on GitHub
scheduleLogIDParam Extension method
Declaration
Swift

var scheduleLogIDParam: PathComponent { get }
Show on GitHub
filenameParam Extension method
Declaration
Swift

var filenameParam: PathComponent { get }
Show on GitHub
imageFilenameParam Extension method
Declaration
Swift

var imageFilenameParam: PathComponent { get }
Show on GitHub
streamPhotoIDParam Extension method
Declaration
Swift

var streamPhotoIDParam: PathComponent { get }
Show on GitHub
performerIDParam Extension method
Declaration
Swift

var performerIDParam: PathComponent { get }
Show on GitHub
personalEventIDParam Extension method
Declaration
Swift

var personalEventIDParam: PathComponent { get }
Show on GitHub


                    
                    
                    dateFromParameter(string:)

Extension method

Transforms a string that might represent a date (either a Double or an ISO 8601 representation) into a Date, if possible.

Note

The representation is expected to be either a string literal Double, or a string in UTC yyyy-MM-dd'T'HH:mm:ssZ format.

Declaration

Swift

static func dateFromParameter(string: String) -> Date?

Parameters


                                string

The string to be transformed.

Return Value

A Date if the conversion was successful, otherwise nil.

Show on GitHub

Guards

guardNotSpecialAccount(_:) Extension method
Declaration
Swift

func guardNotSpecialAccount(_ targetUser: User) throws
Show on GitHub

Notification Management


                    
                    
                    addNotifications(users:type:info:on:)

Extension method, asynchronous

Declaration

Swift

func addNotifications(users: [UUID], type: NotificationType, info: String, on req: Request) async throws

Show on GitHub


                    
                    
                    handleUnreadMessage(req:msgID:inbox:users:group:)

Extension method

Declaration

Swift

func handleUnreadMessage(
	req: Request,
	msgID: UUID,
	inbox: Request.Redis.MailInbox,
	users: [UUID],
	group: inout ThrowingTaskGroup<Void, Error>
) -> [UUID]

Show on GitHub


                    
                    
                    subtractNotifications(users:type:subtractCount:on:)

Extension method, asynchronous

Declaration

Swift

func subtractNotifications(users: [UUID], type: NotificationType, subtractCount: Int = 1, on req: Request)
	async throws

Show on GitHub


                    
                    
                    deleteFezNotifications(userIDs:fez:on:)

Extension method, asynchronous

Declaration

Swift

func deleteFezNotifications(userIDs: [UUID], fez: FriendlyFez, on req: Request) async throws

Show on GitHub


                    
                    
                    markNotificationViewed(user:type:on:)

Extension method, asynchronous

Declaration

Swift

func markNotificationViewed(user: UserCacheData, type: NotificationType, on req: Request) async throws

Show on GitHub


                    
                    
                    storeNextFollowedEvent(userID:on:)

Extension method, asynchronous

Declaration

Swift

func storeNextFollowedEvent(userID: UUID, on req: Request) async throws -> (Date, UUID)?

Show on GitHub


                    
                    
                    storeNextJoinedLFG(userID:on:)

Extension method, asynchronous

Declaration

Swift

func storeNextJoinedLFG(userID: UUID, on req: Request) async throws -> (Date, UUID)?

Show on GitHub

getImagePath(for:format:usage:size:on:) Extension method
Returns the file system path for the given image filename. Makes sure all image directories in the path exist.

Currently, this fn returns paths in the form: /images///.jpg where “xx” is the first 2 characters of the filename.
Declaration
Swift

func getImagePath(for image: String, format: String? = nil, usage: ImageUsage, size: ImageSizeGroup, on req: Request) throws -> URL
Show on GitHub


                    
                    
                    processImages(_:usage:on:)

Extension method, asynchronous

Takes an an array of ImageUploadData as input. Some of the input elements may be new image Data that needs procssing; some of the input elements may refer to already-processed images in our image store. Once all the ImageUploadData elements are processed, returns a [String] containing the filenames where al the images are stored. The use case here is for editing existing content with image attachments in a way that prevents re-uploading of photos that are already on the server.

req: The incoming Request, on which this processing must run.

Declaration

Swift

func processImages(_ images: [ImageUploadData], usage: ImageUsage, on req: Request) async throws -> [String]

Parameters

`images`	The images in `ImageUploadData` format.
`usage`	The type of model using the image content.

Return Value

The generated names of the stored files.

Show on GitHub


                    
                    
                    processImage(data:usage:on:)

Extension method, asynchronous

Takes an optional image in Data form as input, produces full and thumbnail JPEG vrsions, places both the thumbnail and full image in their respective directories, and returns the generated name of the file on success, an empty string otherwise.

req: The incoming Request, on which this processing must run.

Declaration

Swift

func processImage(data: Data?, usage: ImageUsage, on req: Request) async throws -> String?

Parameters

`data`	The uploaded image in `Data` format.
`usage`	The type of model using the image content.

Return Value

The generated name of the stored file, or nil.

Show on GitHub


                    
                    
                    archiveImage(_:on:)

Extension method

Archives an image that is no longer needed other than for accountability tracking, by removing the full-sized image and moving the thumbnail into the archive/ subdirectory of the provided base image directory.

This is a synchronous operation, until such time as we can use SwiftNIO 2’s asynchronous file I/O.

Declaration

Swift

func archiveImage(_ image: String, on req: Request)

Parameters

`image`	The filename of the image.
`imageDir`	The base image directory path for the image’s context.

Show on GitHub