At this level
so.sprk · 9- so.sprk.authCreatePosts permission-set
- so.sprk.authDeleteContent permission-set
- so.sprk.authFullApp permission-set
- so.sprk.authManageFeedDeclarations permission-set
- so.sprk.authManageLabelerService permission-set
- so.sprk.authManageModeration permission-set
- so.sprk.authManageNotifications permission-set
- so.sprk.authManageProfile permission-set
- so.sprk.authViewAll permission-set
- so.sprk.actor.defs defs The subject's followers whom you also follow
- so.sprk.actor.getPreferences query Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.
- so.sprk.actor.getProfile query Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.
- so.sprk.actor.getProfiles query Get detailed profile views of multiple actors.
- so.sprk.actor.getSuggestions query Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.
- so.sprk.actor.profile record A declaration of a Spark account profile.
- so.sprk.actor.putPreferences procedure Set the private preferences attached to the account.
- so.sprk.actor.searchActors query Find actors (profiles) matching search criteria. Does not require auth.
- so.sprk.actor.searchActorsTypeahead query Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.
- so.sprk.feed.defs defs User clicked through to the author of the feed item
- so.sprk.feed.describeFeedGenerator query Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).
- so.sprk.feed.generator record Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.
- so.sprk.feed.getActorFeeds query Get a list of feeds (feed generator records) created by the actor (in the actor's repo).
- so.sprk.feed.getActorLikes query Get a list of posts liked by an actor. Requires auth, actor must be the requesting account.
- so.sprk.feed.getActorReposts query Get a list of posts reposted by an actor.
- so.sprk.feed.getAuthorFeed query Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.
- so.sprk.feed.getCrosspostThread query Get crosspost thread items for an anchor. Mirrors getPostThread shape but uses isolated crosspost-thread traversal.
- so.sprk.feed.getFeed query Get a hydrated feed from an actor's selected feed generator. Implemented by App View.
- so.sprk.feed.getFeedGenerator query Get information about a feed generator. Implemented by AppView.
- so.sprk.feed.getFeedGenerators query Get information about a list of feed generators.
- so.sprk.feed.getFeedSkeleton query Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.
- so.sprk.feed.getLikes query Get like records which reference a subject (by AT-URI and CID).
- so.sprk.feed.getPostThread query Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.
- so.sprk.feed.getPosts query Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.
- so.sprk.feed.getRepostedBy query Get a list of reposts for a given post.
- so.sprk.feed.getSuggestedFeeds query Get a list of suggested feeds (feed generators) for the requesting account.
- so.sprk.feed.getTimeline query Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.
- so.sprk.feed.like record Record declaring a 'like' of a piece of subject content.
- so.sprk.feed.post record Record containing a Spark post.
- so.sprk.feed.reply record Record containing a Spark reply.
- so.sprk.feed.repost record Record representing a 'repost' of an existing Spark post.
- so.sprk.feed.searchPosts query Find posts matching search criteria, returning views of those posts.
- so.sprk.feed.sendInteractions procedure Send information about interactions with feed items back to the feed generator that served them.
- so.sprk.feed.threadgate record Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.
- so.sprk.graph.block record Record declaring a 'block' relationship against another account. NOTE: blocks are public in Spark; see blog posts for details.
- so.sprk.graph.defs defs indicates that a handle or DID could not be resolved
- so.sprk.graph.follow record Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.
- so.sprk.graph.getBlocks query Enumerates which accounts the requesting account is currently blocking. Requires auth.
- so.sprk.graph.getFollowers query Enumerates accounts which follow a specified account (actor).
- so.sprk.graph.getFollows query Enumerates accounts which a specified account (actor) follows.
- so.sprk.graph.getKnownFollowers query Enumerates accounts which follow a specified account (actor) and are followed by the viewer.
- so.sprk.graph.getMutes query Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.
- so.sprk.graph.getRelationships query Enumerates public relationships between one account, and a list of other accounts. Does not require auth.
- so.sprk.graph.getSuggestedFollowsByActor query Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.
- so.sprk.graph.muteActor procedure Creates a mute relationship for the specified account. Mutes are private in Spark. Requires auth.
- so.sprk.graph.muteThread procedure Mutes a thread preventing notifications from the thread and any of its children. Mutes are private in Spark. Requires auth.
- so.sprk.graph.unmuteActor procedure Unmutes the specified account. Requires auth.
- so.sprk.graph.unmuteThread procedure Unmutes the specified thread. Requires auth.
- so.sprk.media.defs defs width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.
- so.sprk.media.image object An image in a Spark record.
- so.sprk.media.images object A set of multiple images in a Spark post.
- so.sprk.media.video object A video in a Spark post.
- so.sprk.notification.getUnreadCount query Count the number of unread notifications for the requesting account. Requires auth.
- so.sprk.notification.listNotifications query Enumerate notifications for the requesting account. Requires auth.
- so.sprk.notification.putPreferences procedure Set notification-related preferences for an account. Requires auth.
- so.sprk.notification.registerPush procedure Register to receive push notifications, via a specified service, for the requesting account. Requires auth.
- so.sprk.notification.unregisterPush procedure The inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account. Requires auth.
- so.sprk.notification.updateSeen procedure Notify server that the requesting account has seen notifications. Requires auth.
- so.sprk.sound.audio record A audio record referencable in a Spark record (e.g, a post)
- so.sprk.sound.defs defs Metadata about the audio content.
- so.sprk.sound.getActorAudios query Get a list of audio records created by the actor.
- so.sprk.sound.getAudioPosts query Get a list of posts that use a given audio (by AT-URI).
- so.sprk.sound.getAudios query Gets audio views for a specified list of audios (by AT-URI).
- so.sprk.sound.getTrendingAudios query Return trending audios ranked by popularity, returning AudioViews.
- so.sprk.sound.searchAudios query Search audio records by title, artist, and metadata.
- so.sprk.story.defs defs
- so.sprk.story.getStories query Gets story views for a specified list of stories (by AT-URI). This is sometimes referred to as 'hydrating' a story reference list.
- so.sprk.story.getTimeline query Get a view of the requesting account's stories timeline grouped by author.
- so.sprk.story.post record Record containing a Spark story.
- so.sprk.video.defs defs Audio extracted from the uploaded video for client-side record creation.
- so.sprk.video.getJobStatus query Get status details for a video processing job.
- so.sprk.video.getUploadLimits query Get video upload limits for the authenticated user.
- so.sprk.video.uploadVideo procedure Upload a video to be processed then stored on the PDS.