DeleteAccountButton class

A button that triggers the deletion of the user's account.

If you want to perform an action after the account is deleted, you can use AccountDeletedAction.

Example usage:

ProfileScreen(
  actions: [
    AccountDeletedAction((context, user) {
      // Do something after the account is deleted.
    }),
  ],
);

or

FirebaseUIActions(
  actions: [
    AccountDeletedAction((context, user) {
      // Do something after the account is deleted.
    }),
  ],
  // MyCustomScreen should use DeleteAccountButton internally.
  child: MyCustomScreen(),
)
Inheritance

Constructors

DeleteAccountButton({Key? key, FirebaseAuth? auth, SignInRequiredCallback? onSignInRequired, DeleteFailedCallback? onDeleteFailed, ButtonVariant variant = ButtonVariant.filled, bool showDeleteConfirmationDialog = false})
A button that triggers the deletion of the user's account.
const

Properties

auth → FirebaseAuth?
The FirebaseAuth instance used to perform authentication against. By default, FirebaseAuth.instance is used.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDeleteFailed DeleteFailedCallback?
A callback that is called if the account deletion fails.
final
onSignInRequired SignInRequiredCallback?
A callback tha is called if the FirebaseAuth requires the user to re-authenticate and approve the account deletion. By default, ReauthenticateDialog is being shown.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showDeleteConfirmationDialog bool
If true, the user will be asked to confirm the account deletion.
final
variant ButtonVariant
An enumeration of the possible button variants.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _DeleteAccountButtonState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited