SyncService class final

Provides com.atproto.sync.* endpoints.

Constructors

SyncService(ATProtoServiceContext _ctx)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getBlob({required String did, required String cid, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<Uint8List>>

Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.

getBlocks({required String did, required List<String> cids, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<Uint8List>>

Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.

getLatestCommit({required String did, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<GetLatestCommitOutput>>

Get the current commit CID & revision of the specified repo. Does not require auth.

getRecord({required String did, required NSID collection, required String rkey, String? commit, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<Uint8List>>

Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.

getRepo({required String did, String? since, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<Uint8List>>

Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.

getRepoStatus({required String did, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<GetRepoStatusOutput>>

Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.

listBlobs({required String did, String? since, int? limit, String? cursor, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<ListBlobsOutput>>

List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS.

listRepos({int? limit, String? cursor, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<ListReposOutput>>

Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyOfUpdate({required String hostname, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<EmptyData>>

Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay.

requestCrawl({required String hostname, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<EmptyData>>

Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.

subscribeRepos({int? cursor, Map<String, dynamic>? $unknown}) → Future<XRPCResponse<Subscription<USubscribeReposMessage>>>

Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited