Menu

fmgp.did.comm.protocol.actionmenu2.Menu
See theMenu companion object
final case class Menu(id: MsgID, thid: Option[MsgID], to: Set[TO], from: Option[FROM], title: String, description: String, errormsg: Option[String], options: Seq[MenuOptionFrom])

A requester is expected to display only one active menu per connection when action menus are employed by the responder. A newly received menu is not expected to interrupt a user, but rather be made available for the user to inspect possible actions related to the responder.

{
 "type": "https://didcomm.org/action-menu/2.0/menu",
 "id": "5678876542344",
 "to" : [ "did:example:bob" ],
 "from" : "did:example:alice",
 "body": {
   "title": "Welcome to IIWBook",
   "description": "IIWBook facilitates connections between attendees by verifying attendance and distributing connection invitations.",
   "errormsg": "No IIWBook names were found.",
   "options": [
     {
       "name": "obtain-email-cred",
       "title": "Obtain a verified email credential",
       "description": "Connect with the BC email verification service to obtain a verified email credential"
     },
     {
       "name": "verify-email-cred",
       "title": "Verify your participation",
       "description": "Present a verified email credential to identify yourself"
     },
     {
       "name": "search-introductions",
       "title": "Search introductions",
       "description": "Your email address must be verified to perform a search",
       "disabled": true
     }
   ]
 }
}

Quick forms:

{
 "type": "https://didcomm.org/action-menu/2.0/menu",
 "id": "5678876542347",
 "thid": "5678876542344",
 "to" : [ "did:example:bob" ],
 "from" : "did:example:alice",
 "title": "Attendance Verified",
 "body": {
   "description": "",
   "options": [
       {
         "name": "submit-invitation",
         "title": "Submit an invitation",
         "description": "Send an invitation for IIWBook to share with another participant"
       },
       {
         "name": "search-introductions",
         "title": "Search introductions",
         "form": {
           "description": "Enter a participant name below to perform a search.",
           "params": [
             {
               "name": "query",
               "title": "Participant name",
               "default": "",
               "description": "",
               "required": true,
               "type": "text"
             }
           ],
           "submit-label": "Search"
         }
       }
   ]
 }
}

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def `type`: PIURI

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product