Messaging
Last updated
Was this helpful?
Last updated
Was this helpful?
Every application has a built-in inbox for receiving messages and an outbox for sending messages. This allows users and applications to send data between each other knowing nothing than the other user’s DID and application name.
Learn more about the messaging architecture.
You can simply open the messaging capabilities for the currently connected application context
as follows:
You can retrieve the 20 most recent messages:
Alternatively, specify optional filter
and options
parameters:
Your application can register a callback function to listen for new inbox messages:
type
— The type of inbox entry. This references a full schema URL.
You can stop listening:
Your application can send messages to other accounts on the Verida network.
This example sends a contact record to a user’s Verida Wallet:
This could be used in two scenarios:
A user sending their own data from one application they control to another
A user sending data to another user within the same application
It can be helpful if the Wallet opens your application in a web browser after the user accepts a message. You can enable this by providing an optional parameter to the config
.
ie:
When sending an inbox message, the sender avatar and name are automatically loaded from the public profile of the sending Verida Account. You will need to set these for your account so they can be loaded by applications across the network (including the Verida Wallet).
You could add your Verida Account to the Verida Wallet and use the mobile app to set a profile avatar and name. This will then be the default for every application used by the sending Verida Account. Alternatively, you could manually set the profile information for the application context sending the inbox message. See Account Profiles for more information on how to achieve this.
Data can be sent to an account (see Outbox example above)
Data can be requested from an account:
Options:
filter
: A JSON filter to apply to the search when locating suitable data to share
userSelect
: Boolean value indicating if the user can select the data to be returned. If false
all matching data will be returned.
userSelectLimit
: Integer limiting how many records a user can select.
The inboxEntry
object utilizes the . The two most important properties are:
data
— The data contained in the inbox entry. This will be an object adhering to the schema specified in type
. .
See for details on each supported inbox message type.
— Send one or many pieces of data to a user
— Request data from a user, supports optional filters and conditions around user’s selecting data
— Send a generic message / notification to a user