meeting_place_core library
Transport-agnostic SDK for the MeetingPlace connection, messaging, and
group protocols: publishing and accepting connection offers, managing
channels and groups, and sending/receiving messages over DIDComm or a
pluggable MeetingPlaceTransport.
Classes
- AcceptDirectConnectionRequest
-
Parameters for
MeetingPlaceCoreSDK.acceptDirectConnection. -
AcceptOfferRequest<
T extends ConnectionOffer> -
Parameters for
MeetingPlaceCoreSDK.acceptOffer. -
AcceptOfferResult<
T extends ConnectionOffer> - The result of MeetingPlaceCoreSDK.acceptOffer.
- AccessListAdd
-
AccessListAdd is an action type of
AclBodywhich grants new permissions to specified entities. - AccessListRemove
-
AccessListRemove is an action type of
AclBodywhich revokes existing permissions from specified entities. - AccessListSet
-
AccessListSet is an action type of
AclBodywhich replaces the entire ACL with the provided permissions. - ApproveConnectionRequestParams
-
Parameters for
MeetingPlaceCoreSDK.approveConnectionRequest. - Attachment
- Represents an attachment in a DIDComm plaintext message, as defined in the DIDComm Messaging specification.
- AttachmentData
- Data container for a DIDComm attachment, as defined in the DIDComm Messaging specification.
- Channel
- A connection between two parties, used to exchange messages once inaugurated.
- ChannelActivityType
-
Known
ChannelActivity.typestring constants. - ChannelAttachmentEvent
- Emitted when the remote party delivers DIDComm attachments during channel inauguration.
- ChannelInauguration
- A channel-inauguration DIDComm message, sent to establish a new channel between two parties.
- ChannelNotification
- Parameters required to dispatch a control-plane channel notification.
- ChannelRepository
- Persists and retrieves Channel entities.
- ConnectionOffer
- An offer to connect, published by one party and accepted by another to establish a Channel.
- ConnectionOfferRepository
- Persists and retrieves ConnectionOffer entities, including GroupConnectionOffers.
- ConnectionRequestApproval
- A connection-request-approval DIDComm message, sent to approve a connection request raised against a published offer.
- ContactCard
- A shareable, self-describing profile card exchanged between connected parties.
- ContactCardAttachment
- A DIDComm message Attachment carrying a contact card.
- ControlPlaneEventHandlerManagerOptions
-
Configuration for
ControlPlaneEventManager. - ControlPlaneStreamEvent
- A control-plane event delivered for a specific Channel.
-
CoreSDKStreamSubscription<
T, S> - Interface for mediator stream subscriptions.
- CreateDirectConnectionRequest
-
Parameters for
MeetingPlaceCoreSDK.createDirectConnection. - DefaultMeetingPlaceCoreSDKLogger
-
Default console logger implementation using
dart:developer. - Device
- A device registered with the control plane API to receive notifications.
- DidCommHistoryQuery
- Fetch queued DIDComm messages for the owner DID.
- DidCommIncomingMessage
- An IncomingMessage received from the DIDComm transport.
- DidCommOutgoingMessage
- An OutgoingMessage routed through the DIDComm transport.
- DidCommSubscription
- Subscribe to incoming DIDComm messages for the owner DID.
- DIDCommTransport
- DIDComm-specific messaging operations that don't have a channel-level analogue on MeetingPlaceTransport and so aren't exposed through it.
- DidManager
- Base class for managing DID documents and their associated verification methods.
- DirectConnectionAcceptanceSession
- Represents an active direct connection acceptance session, created when accepting a direct connection offer as the invitee.
- DirectConnectionOfferSession
- Represents an active direct connection offer session, created when starting a direct connection as the offerer.
- DirectConnectionStream
- A CoreSDKStreamSubscription of DirectConnectionStreamData events.
- DirectConnectionStreamData
- Defines an event emitted to the direct connection stream.
- DownloadMediaRequest
-
Parameters for
MeetingPlaceCoreSDK.downloadMedia. - FetchMessagesRequest
- Parameters for MeetingPlaceMediatorSDK.fetchMessages.
- FindOfferResult
- The result of MeetingPlaceCoreSDK.findOffer.
- Group
- A group of parties connected through group connection offers.
- GroupChannelNotification
- Notifies all members of a group chat via the control-plane group-notify endpoint.
- GroupConnectionOffer
- A ConnectionOffer to join a group.
- GroupMember
- A member of a group.
- GroupMemberInauguration
- A group-member-inauguration DIDComm message, sent to inaugurate a new member into a group and share the group's current membership.
- GroupRepository
- Persists and retrieves Group entities and their members.
- HistoryQuery
- Specifies what historical messages to fetch via MeetingPlaceCoreSDK.fetchHistory.
- IncomingMessage
- A message received from a transport via MeetingPlaceCoreSDK.subscribe or MeetingPlaceCoreSDK.fetchHistory.
- IncomingMessageHandle
- Handle returned by MeetingPlaceCoreSDK.subscribe that exposes the live stream of IncomingMessages for the subscription and a dispose hook that tears down the underlying transport connection.
- IncomingMessageSubscription
- Specifies what to subscribe to when calling MeetingPlaceCoreSDK.subscribe.
- IndividualChannelNotification
-
Notifies a single peer via their
Channel.otherPartyNotificationToken. - InvitationAcceptance
- An invitation-acceptance DIDComm message, sent to accept an invitation to connect.
- InvitationAcceptanceGroup
- An invitation-acceptance-group DIDComm message, sent to accept an invitation to join a group.
- KeyRepository
- Persists key/DID material used to derive and look up local identity keys.
- MediaReference
-
Transport-agnostic identifier for previously sent media that can be
resolved back to bytes via
MessagingService.downloadMedia. - MediatorMessage
- MediatorMessageRequest
- Parameters for MeetingPlaceMediatorSDK.sendMessage and MeetingPlaceMediatorSDK.queueMessage.
- MediatorStreamProcessingResult
-
The outcome of processing a single message delivered by
MediatorStreamSubscription.listen'sonDatacallback. - MediatorStreamSubscriptionOptions
- Options for subscribing to mediator messages.
- MeetingPlaceCoreConfig
-
The mediator and control-plane DIDs a
MeetingPlaceCoreSDKinstance is configured to use. - MeetingPlaceCoreSDK
- Meeting Place Core SDK
- MeetingPlaceCoreSDKLogger
- Logger interface for MeetingPlaceCore SDK.
- MeetingPlaceCoreSDKOptions
-
Tunable configuration for a
MeetingPlaceCoreSDKinstance. - MeetingPlaceMediatorSDK
- The main entry point for interacting with a Meeting Place mediator instance.
- MeetingPlaceTransport
- Transport-agnostic abstraction over channel-based messaging backends.
- MessagingService
- Transport-agnostic facade for the send / subscribe / fetchHistory message operations. Dispatches each call to the appropriate transport. Exception wrapping is handled by the caller (typically the meeting place core SDK).
- OobInvitationMessage
- An out-of-band DIDComm invitation, shared outside of an existing channel (e.g. via a link or QR code) to start a new connection.
- OutgoingMessage
- A message that can be sent through MeetingPlaceCoreSDK.sendMessage, regardless of the underlying transport.
- PlainTextMessage
- Represents a DIDComm v2 Plain Text Message as defined in the DIDComm Messaging specification.
- PublishOfferGroupResult
- The result of publishing a group connection offer.
- PublishOfferRequest
-
Parameters for
MeetingPlaceCoreSDK.publishOffer. -
PublishOfferResult<
T extends ConnectionOffer> - The result of publishing a connection offer.
- RegisterForDidcommNotificationsRequest
-
Parameters for
MeetingPlaceCoreSDK.registerForDIDCommNotifications. - RegisterForDidcommNotificationsResult
- The result of registering for DIDComm notifications via the mediator.
- RemoveMemberFromGroupRequest
-
Parameters for
MeetingPlaceCoreSDK.removeMemberFromGroup. - RepositoryConfig
- Bundles the repository implementations the SDK uses for persistence.
- SendMediaMessageRequest
-
Parameters for
MeetingPlaceCoreSDK.sendMediaMessage. - SendOutreachInvitationRequest
-
Parameters for
MeetingPlaceCoreSDK.sendOutreachInvitation. - TransportEvent
- Transport-agnostic representation of a channel event.
- TransportSubscriptionOptions
- Options controlling the behaviour of a MeetingPlaceTransport.subscribeToEvents call.
- UpdateMessageSyncMarkerRequest
-
Parameters for
MeetingPlaceCoreSDK.updateMessageSyncMarker. - UpdateOffersScoreRequest
-
Parameters for
MeetingPlaceCoreSDK.updateOffersScoreandMeetingPlaceCoreSDK.updateOffersScoreLocally. - UpdateOffersScoreResult
-
Result of
MeetingPlaceCoreSDK.updateOffersScore. - ValidateOfferPhraseResult
- The result of validating an offer mnemonic phrase.
- VdipClient
- Client for sending and receiving VDIP (Verifiable Data Issuance Protocol) messages over the shared DIDComm connection managed by MeetingPlaceCoreSDK.
- VdipIssuedCredentialBody
- Body payload for a VDIP issued credential message containing the serialized credential and associated metadata.
Enums
- AttachmentFormat
- The kinds of content a DIDComm message attachment can carry.
- AttachmentMediaType
- The MIME media types a DIDComm message attachment can carry.
- ChannelStatus
- The stage of a Channel in its lifecycle.
- ChannelTransport
- Transport used for message exchange on a channel.
- ChannelType
- The kind of connection a Channel was created from.
- ConnectionOfferStatus
- The stage of a ConnectionOffer in its lifecycle.
- ConnectionOfferType
- The kind of invitation a ConnectionOffer was published as.
- ControlPlaneEventType
- The kind of notification event received from the control plane.
- EventType
- Represents the type of event that can occur during a direct connection.
- FindOfferResultErrorCode
- Error codes returned in FindOfferResult.errorCode when a matched offer can't be claimed by the caller.
- GroupMembershipType
- The kind of membership a GroupMember holds within a group.
- GroupMemberStatus
- The stage of a GroupMember in its lifecycle.
- GroupStatus
- The stage of a Group in its lifecycle.
- MeetingPlaceControlPlaneSDKErrorCode
-
Error codes carried by
MeetingPlaceControlPlaneSDKExceptionidentifying the specific failure that occurred while executing an SDK command. - MeetingPlaceCoreSDKErrorCode
-
Error codes carried by
MeetingPlaceCoreSDKExceptionto identify the specific failure that occurred within aMeetingPlaceCoreSDKcall. - MeetingPlaceMediatorSDKErrorCode
- Classifies the failure reported by a MeetingPlaceMediatorSDKException.
- MeetingPlaceNotificationProtocol
- The DIDComm protocols used to notify a party's other devices or mediators about Meeting Place activity.
- MeetingPlaceProtocol
- The DIDComm protocols used to drive the Meeting Place connection and group lifecycle.
- MessageWrappingType
- The type of message wrapping as defined by the DIDComm Messaging specification. See: https://identity.foundation/didcomm-messaging/spec/#iana-media-types Each variant describes a specific combination of message types and key wrapping algorithms.
- PlatformType
- The channel through which a device receives notifications.
- SDKConnectionOfferType
- The kind of connection offer to publish or accept.
Extensions
- PlaintextMessageExtension on PlainTextMessage
- Convenience helpers on PlainTextMessage.
Typedefs
-
OnBuildAttachmentsCallback
= Future<
List< Function(Channel channel, Future<Attachment> ?>DidManager> getDidManager(String did)) - Callback to build attachments for outgoing connection messages during the channel inauguration process.
-
OnDisposeCallback
= FutureOr<
void> Function() - Callback invoked when a DirectConnectionStream is disposed.
Exceptions / Errors
- MeetingPlaceControlPlaneSDKException
- Represents a control plane SDK exception.
- MeetingPlaceCoreSDKException
- The exception that is thrown when an error occurs in the SDK.
- MeetingPlaceMediatorSDKException
- Represents a Meeting Place Mediator SDK exception.
- MissingDeviceException
-
Thrown internally when
MeetingPlaceControlPlaneSDK.deviceis accessed before a Device has been set on the SDK instance.