Swiftarr - The v3 Twitarr server (100% documented)

GitHub View on GitHub

Swiftarr Reference UserBylineTag Structure Reference

  • Overview
    • Documentation
    • Contributing
    • Development
    • Roadmap
    • Special Files
    • Release Calendar
  • Operations
    • Configuration
    • MacOS Installation
    • Linux Installation
    • Docker Installation
    • Database Migration
  • Twitarr API
    • Pitch
    • API Overview
    • Canonical Links
    • API Changelist
    • Example
  • Controllers
    • AdminController
    • AlertController
    • AuthController
    • BoardgameController
    • ClientController
    • EventController
    • FezController
    • – FezURLQueryStruct
    • ForumController
    • ImageController
    • KaraokeController
    • ModerationController
    • PhonecallController
    • TestController
    • TwitarrController
    • UserController
    • UsersController
  • Models
    • AlertWord
    • Announcement
    • Boardgame
    • Category
    • DailyTheme
    • Event
    • FezPost
    • ForumEdit
    • ForumPostEdit
    • ForumPost
    • Forum
    • FriendlyFezEdit
    • FriendlyFez
    • KaraokePlayedSong
    • KaraokeSong
    • ModeratorAction
    • MuteWord
    • ProfileEdit
    • RegistrationCode
    • Report
    • TimeZoneChange
    • Token
    • TwarrtEdit
    • Twarrt
    • UserNote
    • UserRole
    • User
  • Enumerations
    • ContentModerationStatus
    • EventModification
    • EventType
    • ExportableFormat
    • FezType
    • GDError
    • ImageSizeGroup
    • ImageUsage
    • ImportableFormat
    • LikeType
    • ModeratorActionType
    • NotificationType
    • ReportType
    • SwiftarrClientApp
    • SwiftarrFeature
    • UserAccessLevel
    • UserRoleType
  • Request Structs
    • AnnouncementCreateData
    • EventsUpdateData
    • FezContentData
    • ForumCreateData
    • ImageUploadData
    • NoteCreateData
    • PostContentData
    • ReportData
    • UserCreateData
    • UserPasswordData
    • UserRecoveryData
    • UserUsernameData
    • UserVerifyData
  • Return Structs
    • AddedUserData
    • AnnouncementData
    • BoardgameData
    • BoardgameResponseData
    • CategoryData
    • CreatedUserData
    • CurrentUserData
    • EventData
    • FezData
    • – MembersOnlyData
    • FezPostData
    • ForumData
    • ForumListData
    • NoteData
    • PostData
    • PostDetailData
    • ProfilePublicData
    • TokenStringData
    • TwarrtData
    • TwarrtDetailData
    • UserHeader
    • UserSearch
  • Extensions
    • Application
    • – Redis
    • – UserCacheStorage
    • – UserCacheStorageKey
    • – UserCacheLockKey
    • – WebSocketStorage
    • – WebSocketStorageKey
    • – WebSocketStorageLockKey
    • Array
    • Bool
    • CharacterSet
    • Collection
    • Comparable
    • Data
    • Date
    • Formatter
    • Formatter
    • ISO8601DateFormatter
    • JSONDecoder
    • – DateDecodingStrategy
    • JSONEncoder
    • – DateEncodingStrategy
    • Model
    • PathComponent
    • QueryBuilder
    • RedisClient
    • Request
    • – Redis
    • – UserCache
    • – WebSocketStorage
    • SiblingsProperty
    • String
    • Substring
    • UUID
  • Migrations
    • CreateAdminUsers
    • CreateAlertWordPivotSchema
    • CreateAlertWordSchema
    • CreateAnnouncementSchema
    • CreateBoardgameFavoriteSchema
    • CreateBoardgameSchema
    • CreateCategories
    • – CategoryCreateInfo
    • CreateCategorySchema
    • CreateClientUsers
    • – ClientUserData
    • CreateCustomEnums
    • CreateDailyThemeSchema
    • CreateEventFavoriteSchema
    • CreateEventSchema
    • CreateFezParticipantSchema
    • CreateFezPostSchema
    • CreateForumEditSchema
    • CreateForumPostEditSchema
    • CreateForumPostSchema
    • CreateForumReadersSchema
    • CreateForums
    • CreateForumSchema
    • CreateFriendlyFezEditSchema
    • CreateFriendlyFezSchema
    • CreateKaraokeFavoriteSchema
    • CreateKaraokePlayedSongSchema
    • CreateKaraokeSongSchema
    • CreateModeratorActionSchema
    • CreateMuteWordSchema
    • CreatePostLikesSchema
    • CreateProfileEditSchema
    • CreateRegistrationCodeSchema
    • CreateReportSchema
    • CreateTestData
    • CreateTestUsers
    • CreateTimeZoneChangeSchema
    • CreateTokenSchema
    • CreateTwarrtEditSchema
    • CreateTwarrtLikesSchema
    • CreateTwarrtSchema
    • CreateUserFavoriteSchema
    • CreateUserNoteSchema
    • CreateUserRoleSchema
    • CreateUserSchema
    • ImportBoardgames
    • ImportEvents
    • ImportKaraokeSongs
    • ImportRegistrationCodes
    • SetInitialCategoryForumCounts
    • SetInitialEventForums
    • UpdateForumReadersLastPostReadSchema
    • UpdateForumReadersMuteSchema
  • Pivots
    • AlertWordPivot
    • BoardgameFavorite
    • EventFavorite
    • FezParticipant
    • ForumReaders
    • KaraokeFavorite
    • PostLikes
    • TwarrtLikes
    • UserFavorite
  • Protocols
    • APIRouteCollection
    • ContentFilterable
    • ExportableFormatter
    • FezProtocol
    • ImportableFormatter
    • LibGdExportableFormatter
    • LibGdImportableFormatter
    • LibGdParametrizableExportFormatter
    • RCFValidatable
    • Reportable
    • Searchable
    • SiteControllerUtils
    • StoredSetting
  • Internal Structs/Classes
    • EventParser
    • Settings
    • – SettingsValue
    • – StoredSettingsValue
  • Site Controllers
    • SiteAdminController
    • – AnnouncementViewData
    • – ManageUserLevelViewContext
    • SiteBoardgameController
    • SiteController
    • SiteEventsController
    • SiteFileController
    • SiteForumController
    • SiteFriendlyFezController
    • – FezTab
    • SiteKaraokeController
    • SiteLoginController
    • – LoginPageContext
    • – UserCreatedContext
    • SiteModController
    • SiteSeamailController
    • – SeamailCreateFormContent
    • – SeamailQueryOptions
    • SiteTwitarrController
    • SiteUserController
  • Middleware
    • SwiftarrErrorMiddleware
    • CalendarSessionFixerMiddleware
    • DisabledAPISectionMiddleware
    • DisabledSiteSectionMiddleware
    • NotificationsMiddleware
    • RequireAdminMiddleware
    • RequireModeratorMiddleware
    • RequireTHOMiddleware
    • RequireTwitarrTeamMiddleware
    • RequireVerifiedMiddleware
    • SiteErrorMiddleware
    • SiteRequireAdminMiddleware
    • SiteRequireModeratorMiddleware
    • SiteRequireTHOMiddleware
    • SiteRequireTwitarrTeamMiddleware
    • SiteRequireVerifiedMiddleware
  • Other Actors
    • ActivePhoneCalls
    • – PhoneCall
  • Other Classes
    • DecoderProxy
    • GDImage
    • – FlipMode
    • – ImageType
    • MKSnippet
    • MKSong
    • ScheduleLog
    • UpdateScheduleJobBase
    • ValidatingDecoder
    • – ValidatingUnkeyedContainer
    • – ValidatingSingleValueContainer
    • ValidatingJSONDecoder
  • Other Global Variables
    • app
    • env
    • usernameSeparatorString
  • Other Enumerations
    • DinnerTeam
    • EventNotificationSetting
  • Other Extensions
    • Foundation.Bundle
  • Other Functions
    • generateContentGroups(from:)
    • generateSchedule(startDate:length:)
    • printEvent(date:startTime:endTime:summary:description:location:categories:uid:)
    • routes(_:)
    • titleAndTab(for:)
    • titleAndTab(for:seamail:)
    • usernameValidations(username:)
  • Other Structures
    • AddFoodDrinkCategory
    • AddJocomojiTag
    • AddWordFormStruct
    • AlertmanagerAlert
    • AlertmanagerWebhookPayload
    • Angle
    • AvatarTag
    • BMPFormatter
    • BoardgameRecommendationData
    • Color
    • CreateCategoriesV2
    • – CategoryCreateInfo
    • CreateFezPostFormContent
    • CreateMKSnippetSchema
    • CreateMKSongSchema
    • CreateMicroKaraokeUser
    • CreatePerformanceIndexes
    • CreateScheduleLogSchema
    • CreateSeamailSearchIndexes
    • CreateSearchIndexes
    • CruiseDayIndexTag
    • DailyThemeData
    • DailyThemeUploadData
    • DinnerTeamTag
    • DisabledFeature
    • DisabledFeaturesGroup
    • EmptyJobPayload
    • ErrorResponse
    • EventPageContext
    • – CruiseDay
    • EventTimeTag
    • EventUpdateDifferenceData
    • EventUpdateLogData
    • FezCreateUpdatePageContext
    • FezEditLogData
    • FezListData
    • FezModerationData
    • FezPostModerationData
    • FezTimeTag
    • FixForumPostPinnedMigration
    • FormatPostTextTag
    • – Usage
    • ForumEditLogData
    • ForumModerationData
    • ForumPageContext
    • ForumPostModerationData
    • ForumPostSearchQueryOptions
    • ForumSearchData
    • ForumsSearchPageContext
    • – SearchType
    • ForumsSortOrder
    • GIFFormatter
    • GameExpansionsContext
    • GameListContext
    • – QueryOptions
    • GameRatingTag
    • GenerateScheduleCommand
    • – Signature
    • HealthResponse
    • ImportTimeZoneChanges
    • JPGFormatter
    • JsonGamesListGame
    • KaraokePerformedSongsData
    • KaraokeSongData
    • KaraokeSongResponseData
    • KeywordData
    • LocalTimeTag
    • MarkdownTextTag
    • MessagePostContext
    • – InitType
    • MessagePostFormContent
    • MicroKaraokeCompletedSong
    • MicroKaraokeController
    • MicroKaraokeOfferPacket
    • MicroKaraokeRecordingData
    • MicroKaraokeSnippetModeration
    • MicroKaraokeSongManifest
    • ModeratorActionLogData
    • ModeratorActionLogResponseData
    • PNGFormatter
    • Paginator
    • PaginatorContext
    • – PageInfo
    • PhoneSocketServerAddress
    • PhoneSocketStartData
    • Point
    • PopulateForumLastPostIDMigration
    • PostEditLogData
    • PostSearchData
    • PostSearchPageContext
    • – SearchType
    • ProfileEditLogData
    • ProfileFormContent
    • ProfileModerationData
    • PublicProfileContext
    • Rectangle
    • RegistrationCodeStatsData
    • RegistrationCodeUserData
    • RelativeTimeTag
    • RenameWhereAndWhen
    • ReportContentGroup
    • ReportModerationData
    • ReportPageContext
    • ReportsContext
    • SettingsAdminData
    • SettingsAppFeaturePair
    • SettingsUpdateData
    • Size
    • SocketFezMemberChangeData
    • SocketFezPostData
    • SocketNotificationData
    • – NotificationTypeData
    • SongInfoJSON
    • StaticTimeTag
    • SwiftarrConfigurator
    • TGAFormatter
    • TIFFFormatter
    • TimeZoneChangeData
    • – Record
    • TimeZoneChangeSet
    • TrunkContext
    • – Tab
    • TwarrtModerationData
    • TwarrtQueryOptions
    • TweetEditPageContext
    • TweetPageContext
    • – FilterType
    • UTCTimeTag
    • UpdateFezParticipantSchema
    • UpdateForumLastPostIDMigration
    • UpdateForumPinnedMigration
    • UpdateForumPostPinnedMigration
    • UpdateJob
    • UpdateScheduleJob
    • UpdateUserDinnerTeamMigration
    • UserAuthorizedToCreateKaraokeLogs
    • UserBylineTag
    • UserCacheData
    • – BasicAuth
    • – TokenAuthenticator
    • – SessionAuth
    • UserEventNotificationJob
    • UserModerationData
    • UserNotificationAlertwordData
    • UserNotificationData
    • – ModeratorNotificationData
    • UserProfileEditContext
    • UserProfileUploadData
    • UserSocket
    • ValidatingKeyedContainer
    • ValidationError
    • ValidationFailure
    • WBMPFormatter
    • WEBPFormatter
    • Xoshiro
  • Other Type Aliases
    • LibGdFormatter
    • LibGdParametrizableFormatter

UserBylineTag

struct UserBylineTag : UnsafeUnescapedLeafTag

Inserts an tag with the given user’s display name and username, linking to the user’s profile page. As an UnsafeUnescaped tag, needs to sanitize user-provided text itself.

Usage: #userByline(userHeader) Or: #userByline(userHeader, “css-class”) to style the link Or: #userByline(userHeader, “short”) to display a shorter link (only the username, no displayname). Or: #userByline(userHeader, “nolink”) to display the username and displayname, without a link Or: #userByline(userHeader, “pronoun”) to display the username and displayname with pronouns.

Show on GitHub
  • render(_:)

    Declaration

    Swift

    func render(_ ctx: LeafContext) throws -> LeafData
    Show on GitHub

© 2024 The Twitarr Team. All rights reserved. (Last updated: 2024-03-21)

Generated by jazzy ♪♫ v0.14.4, a Realm project.