References

controllers

summary
public	C AdminUserActionController Controller for any button that performs an admin use raction.
public	C AnimationController Manages an animated element
public	C AnswerViewController Manages an answer of a given id.
public	C AnswerVoteViewController Voting on answers
public	C CategoryListViewController
public	C CodeEditorTheme
public	C CodeEditorViewController OO-wrapper for a codeeditor.
public	C CommentListViewController Manages a list of comments
public	C CommentViewController Why be smart and use a view controller when you can make your code look like you use React
public	C DeleteCommentViewController Deletes a comment
public	C DeleteItemViewController
public	C EditAnswerViewController
public	C FollowButtonController Creates a follow button.
public	C FullScreenModalTemplate Controls a 'FullScreenModalTemplate' which is used for things like answer UI.
public	C HeaderViewController
public	C ItemGroupViewController Manages an input allowing the user to reset and set other state indicators such as `- Saved`.
public	C LanguageLookupViewController Provides a language search box
public	C LeaderboardViewController Leaderboard buttons and all.
public	C LoadMoreCommentsViewController Manages the "Load More" button
public	C LoadingButtonController Allows button classes with images to have a loading/disabled state.
public	C MarkdownViewController Manages markdown editor
public	C ModalController Manages a modal in a webpage.
public	C ModalViewController This is like ModalController but better.
public	C NotificationBubbleViewController Notification bubble to click on
public	C NukeItemViewController
public	C PopoverViewController Controls a popover view.
public	C PostButtonViewController Controls loading sign etc.
public	C PostVoteViewController Voting on answers
public	C ProgressButtonController Sets an existing `.button` to progress
public	C SearchViewController
public	C SelectDialogViewController Manages a select dialog drop-down
public	C SelectState State of selection
public	C SidebarNavigationViewController Controller for navigation controller
public	C StackExchangeImporterViewController Imports from Stack Exchange
public	C StickyViewController
public	C SwappingViewController Allows swapping between two views
public	C ViewController Manages a View of any type with iOS-esque handlers.
public abstract	C VoteViewController Controls voting
public	C WriteCommentViewController Manages a "Write Comment" button
public	V Animation
public	V BadCodeEditorThemeType
public	V CodeEditorLoadError
public	V CodeEditorModeLoadError
public	V CodeEditorThemeLoadError
public	V InstanceType
public	V OPACITY_TRANSITION_DURATION
public	V CommentDeleteFailed
public	V INVALID_ITEM_GROUP_STRUCTURE
public	V NoInputBox
public	V CommentLoadError
public	V MODAL_BLUR_RADIUS
public	V c
public	V ACTIVE_LINK_OPEN
public	V ACTIVE_SECTION_CLASS_NAME
public	V SCROLL_ELEMENT
public	V VOTE_ACTIVE_CLASS
public	V VOTE_DISABLED_CLASS
public	V VoteFailed
public	V VoteInvalid
public	V VoteUnauthorized
public	V CommentError
public	V CommentLengthBounds
public	V CommentOwnerTypeError
public	T CodeEditorThemeType: Object Type of theme
public	T ScrollProperty: Object

controllers/Form

summary
public	C FormConstraint Specifies what constraints a given form field must satisfy
public	C FormController Performs really basic form validation
public	V NoElementWithId
public	V FORM_VALIDATION_FAILED
public	T ValidationError: Object
public	T Validator: Object

controllers/TIOController

summary
public	C TIOExec Adds a TIO-execute button for a client-side class.
public	V NoCode

delegate

summary
public abstract	C AJAXFormControllerDelegate Submits to same endpoint as original form but instead
public	C NavigationItemDelegate Delegate for items which are opened/closed
public	C SortControllerDelegate Manages a select dialog for sorting
public	I ActionControllerDelegate Action controller delegate.
public	I ActionControllerDelegate Animatino controller delegate.
public	I FormControllerDelegate Represents a form.
public	V SORT_TYPE_KEY

helpers

summary
public	C AnyError Generic error type
public	C ErrorManager
public	C ServiceWorker Call this to get the Axtell server worker.
public	F b64toJSON(base64string: string): Object Converts from a base64 json string to a JSON object
public	F HandleUnhandledPromise()
public	F CodeMirrorMode()
public	F CodeMirrorTheme()
public	F addSchema(schema: Object) Adds a schema JSON to head
public	V Bugsnag
public	V Chartist
public	V CodeMirror
public	V CodeMirrorCLikeModes
public	V CodeMirrorOverlay
public	V LazyLoad
public	V MathQuill
public	V jQuery
public	V Body
public	V Title

interactors

summary
public	C ForeignChildInteractor Interacts with a ForeignInteractor as a parent.
public	C ForeignInteractor
public	F writeDelta()
public	F writeKey()
public	V FOREIGN_INVALID_ID
public	V foreignDigest
public	V sameTabIds

models

summary
public	C Analytics Analytics wrapper
public	C Answer An answer to a challenge
public	C Auth Manages authorization use `Auth.shared()` to get global instance
public	C AuthJWTToken Manages data for a login authorization instance
public	C Comment Represents a comment
public	C Data Manages data passed from server-side
public	C Encoding Represents an encoding
public	C Enum Represents an enumeration
public	C HashManager Manages location hashes.
public	C KeyManager Centralizes key management.
public	C Language Info about a programming language
public	C LoginMethod Login method
public	C Normalize Normalizes strings.
public	C Notification Represents a notification
public	C NotificationCategorizer Categorizes notifications
public	C NotificationCategory Represents a notification category
public	C NotificationGroup Represents a notification group
public	C Post Describes a code-golf post
public	C PushNotification Manages push notifications across different platforms.
public	C Query Represents a searchable index/object.
public	C MultiIndexSearch A group of categories.
public	C Search
public	C SearchCategory
public	C SearchResult Represents a given search result as native object
public	C SearchResults Represents categories or list of results.
public	C StackExchangege Talks to SE API
public	C Theme
public	C User Represents a User
public	I State
public	V EventCategory
public	V EventType
public	V TimingType
public	V INVALID_JSON
public	V COMMENT_COUNT
public	V INVALID_JSON
public	V NO_DATA_TAG
public	V NATIVE_ENCODINGS
public	V KeyAlreadyRegistered
public	V InvalidLanguage
public	V siteMetadata
public	V CommonList: string[] List of common words
public	V MAX_BODY_LENGTH
public	V MAX_TITLE_LENGTH
public	V MIN_BODY_LENGTH
public	V MIN_TITLE_LENGTH
public	V NOT_A_POST
public	V POST_JSON_KEY
public	V PNAPNUnknownResponseState
public	V SearchCategories
public	V DARK_THEME_ID
public	V THEME_DATA_KEY
public	V THEME_IMG_ROOT
public	V INVALID_JSON
public	T AuthConfig: Object
public	T AuthProfile: Object
public	T EnvKey: Object An env key.
public	T Key: Object A global key (not env related).
public	T NotificationCategory: Object
public	T NotificationStatus: number See Notification.getStatuses
public	T NotificationType: number See Notification.getTypes

models/Request

summary
public	C AdminUserAction Performs an admin user action
public	C Post Sends an new answer.
public	C AnswerVote Submits a vote request for an answer
public	C BeaconableRequest A request with beacon flag.
public	C CanonicalPostURL Obtains canonical URL of a post
public	C CommentsRequest Obtains paginated comments
public	C DeleteCommentRequest Deletes a comment
public	C Encoding Obtains an encoding
public	C Encoding Gets all encodings as a name.
public	C FollowUser Follows or unfollows a user.
public	C FollowedUser Gets both followed and following users.
public	C ImgurUpload Uploads to imgur
public	C Leaderboard Obtains a post leaderboard
public	C LoginMethods Returns list of login methods
public	C MarkNotificationStatus This sets notification status
public	C ModifyUser Adjusts user config
public	C Leaderboard Obtains notification data
public	C Notifications Obtains a series of Notification objects
public	C PagedRequest Runs request using Axtell REST paging.
public	C Post Describes a post.
public	C PostVote Submits a vote request for a post
public	C PrivacySettings Obtains privacy settings
public	C PublishDelete Deletes a given item
public	C PublishEdit Represents an edit on a post or answer
public	C PublishNuke Deletes a given item
public	C RemoteEnum Loads a remote enum given a url
public	C RemoveLoginMethod Removes methods
public	C Request
public	C SVG Loads an SVG
public	C UserRequest Obtains a User by ID.
public abstract	C Vote A generic voting type
public	C WebAPNToken Gets WebAPN Token
public	C WebPushKey Obtains the Web Push certificate/public key
public	C WebPushNewDevice Adds webpush device.
public	C WriteCommentRequest Submits a comment
public	V AdminUserActionType List of possible admin user actions.
public	V IMGUR_CLIENT_ID
public	V IMGUR_UPLOAD_ENDPOINT
public	V IMGUR_UPLOAD_HOST
public	T FollowedType: Object
public	T NotificationMarkAllUnseen: Symbol Pass to mark all notifications
public	T EnumEndpoint: Object
public	T HTTPMethod: Object

models/TIO

summary
public	C TIOResult
public	C TIORun Runs some code on TIO.
public	C TIOSerializer TIO uses very-specific format so this serializes things to work for it.
public	C TIO Manages Try It Online execution
public	V NoIndice
public	V TIO_API_ENDPOINT
public	V TIO_ID_WIDTH

serializers

summary
public	I JSONConvertable A class that can be converted to json

svg

summary
public	V Cross
public	V Down
public	V Expand
public	V LoadingIcon

template

summary
public	C AnswerEditTemplate Does the whole 'edit box' thing.
public	C ButtonTemplate A button
public	C CodeEditorTemplate The code editor
public	C CommentTemplate Creates a comment given a Comment object
public	C EncodingFixedTemplate
public	C EncodingTemplate A template representing an encoding.
public	C FollowModalTemplate The modal showing followers or following.
public	C FullScreenModalTemplate See FullScreenModalController
public	C HeaderTemplate
public	C ImageUploadModalTemplate Image upload Modal dialog.
public	C LanguageListTemplate A template representing a list of LanguageTemplate objects.
public	C LanguageFixedTemplate
public	C LanguageTemplate A template representing a language.
public	C LeaderboardItemTemplate A template representing an item on leaderboard.
public	C LinkModalTemplate Image upload Modal dialog.
public	C LoadingTemplate Displays loading sign then goes away.
public	C LoginMethodTemplate Template for a login method.
public	C MarkdownControl Represents a control for the markdown controls list.
public	C MarkdownControlsTemplate Template for a markdown control list.
public	C MarkdownTemplate Markdown editor
public	C MathEditorModalTemplate Math Editor Modal dialog.
public abstract	C ModalTemplate A presentable modal view.
public	C ModalViewTemplate Wrapper for modal templates.
public	C NavigationTemplate Navigation template for friendly nav.
public	C NoNewNotificationsTemplate
public	C NotificationButtonTemplate A little button for notifs
public	C NotificationCategoryTemplate A category of notifications w/ a header
public	C NotificationItemTemplate Represents a single notification.
public	C NotificationListTemplate
public	C PopoverTemplate
public	C ProgressButtonTemplate A loading button thing
public	C PushNotificationRequestTemplate Little bubble asking for enabling PNs
public	C SwappingTemplate Handles swapping
public	C Template Manages a section of HTML used with a view.
public	C TestTag The TestTag element
public	C LanguageTemplate A template representing a user.
public	C UserTemplate A user template for a list of users (generates `li` nodes)
public	F MarkdownControlBuilder()
public	V COMMENT_NEST_DEPTH
public	V FS_MODAL_NOT_OPEN
public	V URL_REGEX
public	V GREEK_LETTERS
public	V TagType
public	T ButtonColor: Object
public	T ButtonStyle: Object
public	T FollowType: Object
public	T FSModalColor: Object Colors of the modal
public	T TemplateType: Object

template/Form

summary
public	C CheckboxInputTemplate Checkbox template.
public	C ConstraintStateTemplate
public	C EncodingInputTemplate Encoding picker template.
public	C LabelGroup A label group is an input along with surrounding metadata.
public	C LanguageInputTemplate Language picker template.
public	C SearchInputTemplate Abstract base for inputs which search
public	C TextInputTemplate
public	I InputInterface Interface for input templates
public	V BadConstraintState
public	V ConstraintState
public	T SearchInputResults: Object
public	T TextInputType: Object

template/ProfileSettings

summary
public	C ProfileSettingsTemplate Wraps all profile settings in a group.
public	C ProfileSettingsView A setting view
public	C ProfileSettingsViewLogins Modify logins view
public	C ProfileSettingsViewPrivacy Main privacy settings page
public	C ProfileSettingsViewProfile Main profile setting page
public	C ProfileSettingsViewSessions Manage current login sessions

template/Search

summary
public	C SearchCategoryTemplate
public	C SearchTemplate
public	V UnknownIndex

template/TIO

summary
public	C TIOOutputTemplate TIO output template.
public	V TIOOutputBadState
public	V TIOOutputState

template/WriteAnswer

summary
public	C WriteAnswerTemplate Instance of FullScreenModalTemplate

template/WritePost

summary
public	C WritePostNavigationItemTemplate
public	C WritePostSubheaderTemplate
public	C WritePostTabChecklist The checklist in the header
public	C WritePostTabChecklistItem A checklist item
public	C WritePostTemplate
public	V BadCheckState
public	V CheckState
public	V UnknownTab
public	V WritePostTab

template/WritePost/Tab

summary
public	C WritePostTabExamples
public	C WritePostTabSubmit
public	C WritePostTabWritePost
public	V NO_BODY
public	V NO_TITLE

summary
public	C AuthModalTemplate Authorization Modal dialog.
public abstract	C LoginMethodSelectorTemplate Login method template for like selecting one

ui

summary
public	V CODEPAGE_TABLE
public	V NOTIFICATION_BUBBLE
public	V NOTIFICATION_WRAPPER
public	V ADMIN_NUKE_TRIGGER_ID
public	V ADMIN_RESET_VOTES_TRIGGER_ID
public	V FOLLOWERS_POPOVER_TRIGGER_ID
public	V FOLLOWING_POPOVER_TRIGGER_ID
public	V FOLLOW_BUTTON_ID
public	V USERBOX_AUTHOR_TRIGGERS

ui/settings

summary
public	V isProfileSettingScreen

ui/views

summary
public	V LEADERBOARD_CLASS_NAME
public	V MARKDOWN_CLASS_NAME
public	V POST_ACTION_CONTAINER

ui/write

summary
public	V ANSWER_TRIGGERS
public	V CREATE_POST_MORE_BUTON
public	V CREATE_POST_MORE_POPOVER
public	V IMPORT_FROM_STACKEXCHANGE
public	V IMPORT_FROM_STACKEXCHANGE_LOGIN
public	V IMPORT_FROM_STACKEXCHANGE_TRIGGER
public	V PREVIEW_WRAPPER
public	V PUBLISH_CATEGORIES_CONTROLLER
public	V PUBLISH_CATEGORIES_LABEL
public	V PUBLISH_FORM
public	V PUBLISH_TYPE_CONTROLLER
public	V PUBLISH_TYPE_FORM_ITEM
public	V CREATE_POST_MORE_BUTON
public	V CREATE_POST_MORE_POPOVER
public	V IMPORT_FROM_STACKEXCHANGE
public	V IMPORT_FROM_STACKEXCHANGE_LOGIN
public	V IMPORT_FROM_STACKEXCHANGE_TRIGGER