AtClientInvitations class
Invitations for one client: the way an app or a CLI uses them.
- Mixed-in types
- Annotations
-
- @experimental
Constructors
- AtClientInvitations(AtClient atClient, {required String invitationsNamespace})
Properties
-
acceptances
→ Future<
AtCollection< InvitationAcceptance> > -
Acceptances, each shared by an invitee with its inviter.
no setterinherited
- atClient → AtClient
-
final
-
connections
→ Future<
AtCollection< InvitationConnection> > -
Confirmations, each shared by an inviter with the invitee it accepted.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- invitationsNamespace → String
-
The app namespace the invitation records live under.
final
- logger → AtSignLogger
-
final
- me → Atsign
-
no setterinherited
-
receivedInvitations
→ Future<
AtCollection< ReceivedInvitation> > -
Invitations this atSign received. Only this atSign reads them.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sentInvitations
→ Future<
AtCollection< SentInvitation> > -
Invitations this atSign sent. Only this atSign reads them.
no setterinherited
Methods
-
accept(
InvitationLink link, String code, {Map< String, dynamic> details = const {}, SealedInvitationContent? outOfBandContent}) → Future<void> -
Accepts an invitation with the
codeits inviter sent separately, sending the inviterdetailsof this atSign's choosing.inherited -
decline(
String id) → Future< void> -
Forgets an invitation, and withdraws this atSign's acceptance of it if
there is one.
inherited
-
invite(
{Map< String, dynamic> publicDetails = const {}, Map<String, dynamic> ? content, bool contentOutOfBand = false, Duration expiresIn = const Duration(days: 7)}) → Future<CreatedInvitation> -
Creates an invitation. The app links its own records, such as a
contact, to it by the id in the returned link.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
preview(
InvitationLink link, {SealedInvitationContent? outOfBandContent}) → Future< CItem< ReceivedInvitation> > -
Fetches an invitation's preview and keeps it, with its content when the
content travels in the preview.
outOfBandContentis content that travelled some other way, e.g. in an email. It can arrive after the inviter has confirmed this atSign; processConnections then opens it.inherited -
processAcceptances(
) → Future< List< ({CItem< >InvitationAcceptance> acceptance, InvitationOutcome outcome})> -
Handles every acceptance of this atSign's pending invitations, and
finishes any invitation a client decided but did not finish. Reports
each acceptance it handled; one of an invitation already decided is not
reported again.
inherited
-
processConnections(
) → Future< List< CItem< >ReceivedInvitation> > -
Completes every invitation this atSign accepted whose inviter has
confirmed it, decrypting any content, and returns those it completed.
The app adds the inviter to its own contacts from these, or from any
received invitation whose status is connected.
inherited
-
revoke(
String id) → Future< bool> -
Cancels a pending invitation. Returns false when it had already been
decided — accepted, burned or revoked.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited