did
API
Generated with
did/fmgp/fmgp.did/fmgp.did.comm/fmgp.did.comm.protocol/fmgp.did.comm.protocol.actionmenu2

fmgp.did.comm.protocol.actionmenu2

package fmgp.did.comm.protocol.actionmenu2

Members list

Type members

Classlikes

final case class Form(description: String, params: Seq[FromParam], submit-label: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Form.type
final case class FromParam(name: String, title: String, default: String, description: Option[String], required: Option[Boolean], `type`: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
FromParam.type
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.

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Menu

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Menu.type
final case class MenuForm(name: String, title: String, form: Form) extends MenuOptionFrom

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
MenuForm.type
final case class MenuOption(name: String, title: String, description: String, disabled: Option[Boolean]) extends MenuOptionFrom

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
MenuOption.type
sealed trait MenuOptionFrom

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MenuForm
class MenuOption
object MenuOptionFrom

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Perform(id: MsgID, thid: MsgID, to: Set[TO], from: Option[FROM], lang: Option[String], name: String, params: Option[Map[String, String]]) 
{
 "type": "https://didcomm.org/action-menu/2.0/perform",
 "id": "5678876542346",
 "thid": "5678876542344",
 "to" : [ "did:example:alice" ],
 "from" : "did:example:bob",
 "body":{
   "name": "obtain-email-cred",
   "params": {}
 }
}

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Perform.type

Extensions

Extensions

Generated with