ServerService class final

Provides com.atproto.server.* endpoints.

Constructors

ServerService(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

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

Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup.

checkAccountStatus({Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<CheckAccountStatusOutput>>

Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.

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

Confirm an email using a token from com.atproto.server.requestEmailConfirmation.

createAccount({String? email, required String handle, String? did, String? inviteCode, String? verificationCode, String? verificationPhone, String? password, String? recoveryKey, Map<String, dynamic>? plcOp, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<CreateAccountOutput>>

Create an account. Implemented by PDS.

createAppPassword({required String name, bool? privileged, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<AppPassword>>

Create an App Password.

createInviteCode({required int useCount, String? forAccount, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<CreateInviteCodeOutput>>

Create an invite code.

createInviteCodes({required int codeCount, required int useCount, List<String>? forAccounts, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<CreateInviteCodesOutput>>

Create invite codes.

deactivateAccount({DateTime? deleteAfter, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<EmptyData>>

Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.

deleteAccount({required String did, required String password, required String token, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<EmptyData>>

Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.

describeServer({Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<DescribeServerOutput>>

Describes the server's account creation requirements and capabilities. Implemented by PDS.

getAccountInviteCodes({bool? includeUsed, bool? createAvailable, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<GetAccountInviteCodesOutput>>

Get all invite codes for the current account. Requires auth.

getServiceAuth({required String aud, int? exp, NSID? lxm, Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<GetServiceAuthOutput>>

Get a signed token on behalf of the requesting DID for the requested service.

getSession({Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<GetSessionOutput>>

Get information about the current auth session. Requires auth.

listAppPasswords({Map<String, String>? $unknown, Map<String, String>? $headers, GetClient? $client}) → Future<XRPCResponse<ListAppPasswordsOutput>>

List all App Passwords.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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

Initiate a user account deletion via email.

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

Request an email with a code to confirm ownership of email.

requestEmailUpdate({Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<RequestEmailUpdateOutput>>

Request a token in order to update email.

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

Initiate a user account password reset via email.

reserveSigningKey({String? did, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<ReserveSigningKeyOutput>>

Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.

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

Reset a user account password using a token.

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

Revoke an App Password by name.

toString() → String

A string representation of this object.

inherited

updateEmail({required String email, bool? emailAuthFactor, String? token, Map<String, String>? $unknown, Map<String, String>? $headers, PostClient? $client}) → Future<XRPCResponse<EmptyData>>

Update an account's email.

Operators

operator ==(Object other) → bool

The equality operator.

inherited