atproto library
Classes
- Account
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#account
- AccountCodes
- https://atprotodart.com/docs/lexicons/com/atproto/server/createinvitecodes/#output
- AccountStatus
- https://atprotodart.com/docs/lexicons/com/atproto/server/checkAccountStatus/#output
- AppPassword
- https://atprotodart.com/docs/lexicons/com/atproto/server/createapppassword/#apppassword
- AppPasswords
- ATProto
-
Provides
com.atproto.*services. - AtUri
- This is the Dart implementation of AT Uri in AT Protocol.
- AuthToken
- Represents an issued token associated session.
- BatchAction
- https://atprotodart.com/docs/lexicons/com/atproto/repo/applywrites/#input
- Blob
- https://atproto.com/specs/data-model#blob-type
- BlobConverter
- BlobData
- BlobRef
- https://atproto.com/specs/data-model#blob-type
- BlobRefs
- Hold a reference links to blobs.
- CID
- This is a simple implementation of V1 CID, or a content identifier. CID is a label used to point to material in IPFS.
- Commit
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#commit
- CreateAccountOutput
- https://atprotodart.com/docs/lexicons/com/atproto/server/createaccount/#output
- CreateAction
- https://atprotodart.com/docs/lexicons/com/atproto/repo/applyWrites#create
- CreatedInviteCode
- https://atprotodart.com/docs/lexicons/com/atproto/server/createinvitecode/#output
- CreatedInviteCodes
- https://atprotodart.com/docs/lexicons/com/atproto/server/createInviteCodes#output
- CurrentSession
- https://atprotodart.com/docs/lexicons/com/atproto/server/getSession#output
- DeleteAction
- https://atprotodart.com/docs/lexicons/com/atproto/repo/applyWrites#delete
- DID
- https://atprotodart.com/docs/lexicons/com/atproto/identity/resolveHandle#output
- DidCredentials
- https://atprotodart.com/docs/lexicons/com/atproto/identity/GetRecommendedDidCredentials#output
- EmailUpdate
- https://atprotodart.com/docs/lexicons/com/atproto/server/requestemailupdate/#output
- EmptyData
- An object representing a state that is empty instead of null.
- GetRepoStatusOutput
- https://atprotodart.com/docs/lexicons/com/atproto/sync/getRepoStatus/#output
- Handle
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#handle
- Identity
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#identity
- IdentityService
-
Represents
com.atproto.identity.*service. - Info
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#info
- InviteCode
- https://atprotodart.com/docs/lexicons/com/atproto/server/defs/#invitecode
- InviteCodes
- https://atprotodart.com/docs/lexicons/com/atproto/server/getAccountInviteCodes#output
- InviteCodeUse
- https://atprotodart.com/docs/lexicons/com/atproto/server/defs/#invitecodeuse
- Jitter
- Label
- https://atprotodart.com/docs/lexicons/com/atproto/label/defs#label
- Labels
- LabelsByQuery
- https://atprotodart.com/docs/lexicons/com/atproto/label/queryLabels#output
- LabelService
-
Represents
com.atproto.label.*service. - LabelValueDefinition
- https://atprotodart.com/docs/lexicons/com/atproto/label/defs/#labelvaluedefinition
- LabelValueDefinitionStrings
- https://atprotodart.com/docs/lexicons/com/atproto/label/defs/#labelvaluedefinitionstrings
- Migrate
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#migrate
- MissingBlobs
- https://atprotodart.com/docs/lexicons/com/atproto/repo/listMissingBlobs
- ModerationService
-
Represents
com.atproto.moderation.*service. - NSID
- This is the Dart implementation of NSID in AT Protocol.
- PlcOperation
- https://atprotodart.com/docs/lexicons/com/atproto/identity/signPlcOperation
- RateLimit
- Represents the rate limit applied to an API or a service.
- RateLimitPolicy
- Represents a policy for rate limiting.
- Record
- https://atprotodart.com/docs/lexicons/com/atproto/repo/listrecords/#record
- RecordBlob
- https://atprotodart.com/docs/lexicons/com/atproto/repo/listmissingblobs/#recordblob
- Records
- https://atprotodart.com/docs/lexicons/com/atproto/repo/listrecords/#output
- Repo
- https://atprotodart.com/docs/lexicons/com/atproto/sync/listrepos/#repo
- RepoBlock
- https://atprotodart.com/docs/lexicons/com/atproto/sync/getblocks/#output
- RepoBlocks
- https://atprotodart.com/docs/lexicons/com/atproto/sync/getblocks/#output
- RepoCommit
- https://atprotodart.com/docs/lexicons/com/atproto/sync/getrepo/#output
- RepoCommits
- Represents a collection of RepoCommit objects.
- RepoInfo
- Represents detailed information about a repository.
- RepoLatestCommit
- https://atprotodart.com/docs/lexicons/com/atproto/sync/getlatestcommit/#output
- RepoOp
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscriberepos/#repoop
- RepoRef
- https://atprotodart.com/docs/lexicons/com/atproto/admin/defs#reporef
- Report
- https://atprotodart.com/docs/lexicons/com/atproto/moderation/createreport/#output
- ReportSubject
- https://atprotodart.com/docs/lexicons/com/atproto/moderation/createreport/#input https://atprotodart.com/docs/lexicons/com/atproto/moderation/createreport/#output
- Repos
- https://atprotodart.com/docs/lexicons/com/atproto/sync/listrepos/#output
- RepoService
-
Represents
com.atproto.repo.*service. - RetryConfig
- This class represents an automatic retry configuration.
- RetryEvent
- This class represents the event during the retry process.
- SealedAppPassword
- https://atprotodart.com/docs/lexicons/com/atproto/server/listAppPasswords#apppassword
- SelfLabel
- https://atprotodart.com/docs/lexicons/com/atproto/label/defs#selflabel
- SelfLabels
- https://atprotodart.com/docs/lexicons/com/atproto/label/defs#selflabels
- Serializable
- ServerInfo
- https://atprotodart.com/docs/lexicons/com/atproto/server/describeserver/#output
- ServerInfoContact
- https://atprotodart.com/docs/lexicons/com/atproto/server/describeserver/#contact
- ServerInfoLinks
- https://atprotodart.com/docs/lexicons/com/atproto/server/describeserver/#links
- ServerService
-
Represents
com.atproto.server.*service. - ServiceAuthToken
- https://atprotodart.com/docs/lexicons/com/atproto/server/GetServiceAuth/#output
- Session
- Represents a user session.
- SigningKey
- https://atprotodart.com/docs/lexicons/com/atproto/server/reservesigningkey/#output
- SignupQueue
- https://atprotodart.com/docs/lexicons/com/atproto/temp/checkSignupQueue/#output
- StrongRef
- https://atprotodart.com/docs/lexicons/com/atproto/repo/strongRef#main
- SubscribedLabel
- https://atprotodart.com/docs/lexicons/com/atproto/label/subscribelabels/#output
- SubscribedLabelInfo
- https://atprotodart.com/docs/lexicons/com/atproto/label/subscribeLabels#info
- SubscribedLabelLabels
- https://atprotodart.com/docs/lexicons/com/atproto/label/subscribeLabels#labels
- SubscribedRepo
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#output
- SyncService
-
Represents
com.atproto.sync.*service. - TempService
-
Represents
com.atproto.temp.*service. - Tombstone
- https://atprotodart.com/docs/lexicons/com/atproto/sync/subscribeRepos#tombstone
- TransferredAccount
- UBatchActionCreate
- UBatchActionDelete
- UBatchActionUpdate
- ULabelsSelLabels
- ULabelsUnknown
- UpdateAction
- https://atprotodart.com/docs/lexicons/com/atproto/repo/applyWrites#update
- UReportSubjectRepoRef
- UReportSubjectStrongRef
- UReportSubjectUnknown
- USubscribedLabelInfo
- USubscribedLabelLabels
- USubscribedLabelUnknown
- USubscribedRepoAccount
- USubscribedRepoCommit
- USubscribedRepoHandle
- USubscribedRepoIdentity
- USubscribedRepoInfo
- USubscribedRepoMigrate
- USubscribedRepoTombstone
- USubscribedRepoUnknown
- XRPCError
- XRPCRequest
- A class that represents a Request sent during XRPC communication.
-
XRPCResponse<
D> - The class represents the response from ATP server.
Enums
- AuthScope
- HttpMethod
- HttpStatus
- LabelValue
- ModerationReasonType
- Multicodec
- Represents multicodecs types.
- Platform
- Protocol
- RepoAction
Extensions
Constants
- labelsConverter → const _LabelsConverter
Functions
-
createSession(
{Protocol? protocol, String? service, required String identifier, required String password, String? authFactorToken, RetryConfig? retryConfig, PostClient? mockedPostClient}) → Future< XRPCResponse< Session> > - https://atprotodart.com/docs/lexicons/com/atproto/server/createSession
-
decodeJwt(
String jwt) → AuthToken -
Returns the decoded AuthToken based on
jwt. -
deleteSession(
{Protocol? protocol, String? service, required String refreshJwt, RetryConfig? retryConfig, PostClient? mockedPostClient}) → Future< XRPCResponse< EmptyData> > - https://atprotodart.com/docs/lexicons/com/atproto/server/deleteSession
-
isValidAppPassword(
String appPassword) → bool - Checks if a given application password is valid based on a predefined regular expression pattern.
-
refreshSession(
{Protocol? protocol, String? service, required String refreshJwt, RetryConfig? retryConfig, PostClient? mockedPostClient}) → Future< XRPCResponse< Session> > - https://atprotodart.com/docs/lexicons/com/atproto/server/refreshSession
Typedefs
-
GetClient
= Future<
Response> Function(Uri url, {Map<String, String> ? headers}) -
A function type abstracted from
http.get, mainly for mocking at test time. -
PostClient
= Future<
Response> Function(Uri url, {Object? body, Encoding? encoding, Map<String, String> ? headers}) -
A function type abstracted from
http.post, mainly for mocking at test time. -
ResponseDataAdaptor
= Map<
String, dynamic> Function(dynamic data) - Function to convert response data to an specific structure.
-
ResponseDataBuilder<
T> = T Function(Map< String, Object?> json) - A function type that expresses the function of converting response body to model objects.
Exceptions / Errors
- InternalServerErrorException
- InvalidCidError
- Indicates that the passed CID could not be parsed.
- InvalidRequestException
- RateLimitExceededException
- XRPCException
- This exception indicates that an unexpected error occurred when communicating with the ATP server.
- XRPCNotSupportedException