API Reference proto_rune v0.1.1
Modules
Generated schema for adultContentPref
Generated schema for bskyAppProgressGuide
Generated schema for bskyAppStatePref
Generated schema for contentLabelPref
Generated schema for feedViewPref
Generated schema for hiddenPostsPref
Generated schema for interestsPref
Generated schema for knownFollowers
Generated schema for labelerPrefItem
Generated schema for labelersPref
Generated schema for mutedWord
Generated schema for mutedWordTarget
Generated schema for mutedWordsPref
Generated schema for nux
Generated schema for personalDetailsPref
Generated schema for preferences
Generated schema for profileAssociated
Generated schema for profileAssociatedChat
Generated schema for profileView
Generated schema for profileViewBasic
Generated schema for profileViewDetailed
Generated schema for savedFeed
Generated schema for savedFeedsPref
Generated schema for savedFeedsPrefV2
Generated schema for threadViewPref
Generated schema for viewerState
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated schema for main
Generated schema for main
Generated schema for aspectRatio
Generated schema for main
Generated schema for external
Generated schema for view
Generated schema for viewExternal
Generated schema for main
Generated schema for image
Generated schema for view
Generated schema for viewImage
Generated schema for main
Generated schema for view
Generated schema for viewBlocked
Generated schema for viewDetached
Generated schema for viewNotFound
Generated schema for viewRecord
Generated schema for main
Generated schema for view
Generated schema for main
Generated schema for caption
Generated schema for view
Generated schema for blockedAuthor
Generated schema for blockedPost
Token type for clickthroughAuthor
Token type for clickthroughEmbed
Token type for clickthroughItem
Token type for clickthroughReposter
Generated schema for feedViewPost
Generated schema for generatorView
Generated schema for generatorViewerState
Generated schema for interaction
Token type for interactionLike
Token type for interactionQuote
Token type for interactionReply
Token type for interactionRepost
Token type for interactionSeen
Token type for interactionShare
Generated schema for notFoundPost
Generated schema for postView
Generated schema for reasonRepost
Generated schema for replyRef
Token type for requestLess
Token type for requestMore
Generated schema for skeletonFeedPost
Generated schema for skeletonReasonRepost
Generated schema for threadViewPost
Generated schema for threadgateView
Generated schema for viewerState
Generated query module for main
Generated schema for feed
Generated schema for links
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for like
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for entity
Generated schema for replyRef
Generated schema for textSlice
Generated schema for main
Generated schema for disableRule
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated schema for main
Generated schema for followingRule
Generated schema for listRule
Generated schema for mentionRule
Generated schema for main
Token type for curatelist
Generated schema for listItemView
Generated schema for listPurpose
Generated schema for listView
Generated schema for listViewBasic
Generated schema for listViewerState
Token type for modlist
Generated schema for notFoundActor
Token type for referencelist
Generated schema for relationship
Generated schema for starterPackView
Generated schema for starterPackViewBasic
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for main
Generated schema for feedItem
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for labelerPolicies
Generated schema for labelerView
Generated schema for labelerViewDetailed
Generated schema for labelerViewerState
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for notification
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for main
Generated schema for byteSlice
Generated schema for link
Generated schema for mention
Generated schema for tag
Generated schema for skeletonSearchActor
Generated schema for skeletonSearchPost
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for suggestion
Generated schema for main
Generated schema for main
Generated schema for jobStatus
Generated schema for main
Generated query module for main
Generated procedure module for main
The ProtoRune.Bot
module provides the foundational behavior and macros for building bots
in the ProtoRune ecosystem. It defines the basic structure for bots and ensures that every bot
adheres to a consistent interface, with customizable event handling, identifier, and password
retrieval.
A GenServer module that handles periodic polling of notifications for a bot, and dispatches these notifications to the appropriate handler functions within the bot.
The ProtoRune.Bot.Server
module is responsible for managing bot processes in ProtoRune.
It handles bot initialization, session management, and event/message dispatching. This
module also integrates with the polling system to retrieve real-time notifications from
ATProto and Bluesky services.
Generated schema for main
Generated schema for profileViewBasic
Generated procedure module for main
Generated query module for main
Generated schema for convoView
Generated schema for deletedMessageView
Generated schema for logBeginConvo
Generated schema for logCreateMessage
Generated schema for logDeleteMessage
Generated schema for logLeaveConvo
Generated schema for messageInput
Generated schema for messageRef
Generated schema for messageView
Generated schema for messageViewSender
Generated procedure module for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for batchItem
Generated procedure module for main
Generated procedure module for main
Generated schema for main
Generated schema for metadata
Generated schema for main
Generated procedure module for main
Generated schema for accountView
Generated schema for repoBlobRef
Generated schema for repoRef
Generated schema for statusAttr
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated query module for main
Generated procedure module for main
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for label
Generated schema for labelValue
Generated schema for labelValueDefinition
Generated schema for labelValueDefinitionStrings
Generated schema for selfLabel
Generated schema for selfLabels
Generated schema for main
Generated schema for main
Generated schema for info
Generated schema for labels
Generated procedure module for main
Token type for reasonAppeal
Token type for reasonMisleading
Token type for reasonOther
Token type for reasonRude
Token type for reasonSexual
Token type for reasonSpam
Generated schema for reasonType
Token type for reasonViolation
Generated procedure module for main
Generated schema for create
Generated schema for createResult
Generated schema for delete
Generated schema for deleteResult
Generated schema for mainErrorInvalidSwap
Generated schema for update
Generated schema for updateResult
Generated procedure module for main
Generated schema for mainErrorInvalidSwap
Generated schema for commitMeta
Generated procedure module for main
Generated schema for mainErrorInvalidSwap
Generated schema for main
Generated schema for main
Generated procedure module for main
Generated schema for main
Generated schema for recordBlob
Generated schema for main
Generated schema for record
Generated procedure module for main
Generated schema for mainErrorInvalidSwap
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated query module for main
Generated procedure module for main
Generated schema for mainErrorAccountNotFound
Generated schema for mainErrorExpiredToken
Generated schema for mainErrorInvalidEmail
Generated schema for mainErrorInvalidToken
Generated procedure module for main
Generated schema for mainErrorHandleNotAvailable
Generated schema for mainErrorIncompatibleDidDoc
Generated schema for mainErrorInvalidHandle
Generated schema for mainErrorInvalidInviteCode
Generated schema for mainErrorInvalidPassword
Generated schema for mainErrorUnresolvableDid
Generated schema for mainErrorUnsupportedDomain
Generated procedure module for main
Generated schema for appPassword
Generated schema for mainErrorAccountTakedown
Generated procedure module for main
Generated procedure module for main
Generated schema for accountCodes
Generated procedure module for main
Generated schema for mainErrorAccountTakedown
Generated schema for mainErrorAuthFactorTokenRequired
Generated procedure module for main
Generated schema for inviteCode
Generated schema for inviteCodeUse
Generated procedure module for main
Generated schema for mainErrorExpiredToken
Generated schema for mainErrorInvalidToken
Generated procedure module for main
Generated query module for main
Generated schema for contact
Generated schema for links
Generated schema for main
Generated schema for main
Generated query module for main
Generated query module for main
Generated schema for appPassword
Generated schema for mainErrorAccountTakedown
Generated procedure module for main
Generated schema for mainErrorAccountTakedown
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated procedure module for main
Generated schema for mainErrorExpiredToken
Generated schema for mainErrorInvalidToken
Generated procedure module for main
Generated procedure module for main
Generated schema for mainErrorExpiredToken
Generated schema for mainErrorInvalidToken
Generated schema for mainErrorTokenRequired
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for repo
Generated procedure module for main
Generated procedure module for main
Generated schema for main
Generated schema for account
Generated schema for commit
Generated schema for handle
Generated schema for identity
Generated schema for info
Generated schema for migrate
Generated schema for repoOp
Generated schema for tombstone
Generated query module for main
Generated schema for main
Generated procedure module for main
Generated procedure module for main
Generated schema for mainErrorDuplicateTemplateName
Generated schema for templateView
Generated procedure module for main
Generated query module for main
Generated procedure module for main
Generated schema for mainErrorDuplicateTemplateName
Generated schema for blobView
Generated schema for imageDetails
Generated schema for modEventAcknowledge
Generated schema for modEventComment
Generated schema for modEventDivert
Generated schema for modEventEmail
Generated schema for modEventEscalate
Generated schema for modEventLabel
Generated schema for modEventMute
Generated schema for modEventMuteReporter
Generated schema for modEventReport
Generated schema for modEventResolveAppeal
Generated schema for modEventReverseTakedown
Generated schema for modEventTag
Generated schema for modEventTakedown
Generated schema for modEventUnmute
Generated schema for modEventUnmuteReporter
Generated schema for modEventView
Generated schema for modEventViewDetail
Generated schema for moderation
Generated schema for moderationDetail
Generated schema for recordView
Generated schema for recordViewDetail
Generated schema for recordViewNotFound
Generated schema for repoView
Generated schema for repoViewDetail
Generated schema for repoViewNotFound
Token type for reviewClosed
Token type for reviewEscalated
Token type for reviewNone
Token type for reviewOpen
Generated schema for subjectReviewState
Generated schema for subjectStatusView
Generated schema for videoDetails
Generated procedure module for main
Generated schema for mainErrorSubjectHasAction
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated schema for main
Generated query module for main
Generated schema for serviceConfig
Generated schema for viewerConfig
Generated procedure module for main
Generated schema for mainErrorMemberAlreadyExists
Generated schema for member
Token type for roleAdmin
Token type for roleModerator
Token type for roleTriage
Generated procedure module for main
Generated schema for mainErrorCannotDeleteSelf
Generated schema for mainErrorMemberNotFound
Generated schema for main
Generated procedure module for main
Generated schema for mainErrorMemberNotFound
Yeah, in house string casing
The XRPC.Client
module handles executing queries and procedures in the XRPC system. It interacts with external services through HTTP requests and performs response validation and schema parsing. The client supports both GET and POST requests, depending on whether the request is a query or a procedure.
The XRPC.DSL
module provides macros to define queries and procedures for interacting with the XRPC system, simplifying the creation of API methods for querying or performing procedures. It supports building custom XRPC queries and procedures by encoding method names and dynamically generating functions based on user-defined parameters.
The XRPC.Procedure
module represents a procedure in the XRPC system, encapsulating the method name, request body, and a parser for validating the body. It provides functions to create and manipulate procedure structures.
The XRPC.Query
module is responsible for defining and managing queries in the XRPC system. It encapsulates the method, parameters, headers, and an optional parser, providing functions to create and manipulate query structures.
Mix Tasks
Mix task to generate Elixir modules from Lexicon schema definitions.