QuickButtonCommand

Description

This object represents a type of button sent as a part of UIstate. QuickButton is powerful item of Ui that provides execution of various functions in messenger client with the use of form action mechanism.

Structure

There are 2 main enum types of action:

• QUICK_REQUEST
• QUICK_FORM_ACTION

QUICK_REQUEST

For this messenger client would return to a service an update QuickButtonSelected with a metadata string after this button is pushed.

QUICK_FORM_ACTION

For this messenger client calls a specific function determined by json object sent in metadata after this button is pushed (contents of json object in metadata must be shielded). This type of action may invoke native mobile device functions as well.

Template of json object for metadata:

		"metadata"= "{
            "action":"QUICK_FORM_ACTION*",
            "data_template":"data template*"
         }"
	

Types of QUICK_FORM_ACTION*

There are folowing types of QUICK_FORM_ACTION:

• send_message
• submit_form
• open_url
• share_data
• open_peer
• redirect_call
• send_private_data

send_message

This type of action provides sending text or content in a form (included in UiState) to a dialog.

For this action service gets FormMessageSent update that means that through the use of this action a new message was sent to dialog (no message update is sent).

submit_form

This type of action provides sending metadata to a service without sending a message to a dialog.

For this action service gets FormSubmitted update that means that user pushed this button.

open_url

This type of action provides opening weblink/deep link specified in metadata in a native web browser or app.

For this action service gets FormSubmitted update that means that user pushed this button.

share_data

This type of action provides sharing text specified in metadata by opening list of apps to use for sharing.

For this action service gets FormSubmitted update that means that user pushed this button.

open_peer

This type of action provides opening a dialog with a peer specified in metadata or opening it's profile.

For this action service gets FormSubmitted update that means that user pushed this button.

If peer is a service and user already has a dialog with it then this dialog is to be opened, if user doesn’t have a dialog with a service then client opens this service’s profile.

If peer is a user client opens a user profile.

Opening a group dialog or channel is not supported.

redirect_call

This type of action provides invoking native calling app with a phone number filled and ready to make a phone call.

For this action service gets FormSubmitted update that means that user pushed this button.

send_private_data

This type of action provides sending user's phone number registered for account to a dialog.

For this action service gets FormMessageSent (for updated services) and FormSubmitted (for old services) updates that means that through the use of this action a new message was sent to dialog (no message update is sent).

Every form action needs specific data template to be sent in json object.

* number from 0 to 9, max 15 symbols

Sample object

"quickButtonCommands": [
 	 			{
 		 			"caption":"Send your phone #",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"send_private_data\",\r\n   \"data_template\" : \"phone XXX\"\r\n}"
 		 		},
 	 			{
 		 			"caption":"Empty Button",
 		 			"action":"QUICK_REQUEST",
 		 			"metadata":"test"
 	 			},
 	 			{
 		 			"caption":"Go to link",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"open_url\",\r\n   \"data_template\" : \"https://www.youtube.com/watch?v=XNJTVLFotr0\"\r\n}"
 	 			},
 	 			{
 		 			"caption":"Send message",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"send_message\",\r\n   \"data_template\" : \"Yes, you can!\"\r\n}"
 	 			},
 	 			{
 		 			"caption":"Share text",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"share_data\",\r\n   \"data_template\" : \"Share me\"\r\n}"
 	 			},
 	 			{
 		 			"caption":"Open peer",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"open_peer\",\r\n   \"data_template\" : \"@MasterService\"\r\n}"
 	 			},
 	 			{
 		 			"caption":"Call me maybe",
 		 			"action":"QUICK_FORM_ACTION",
 		 			"metadata":"{\r\n   \"action\" : \"redirect_call\",\r\n   \"data_template\" : \"+7**********\"\r\n}"
 	 			}
 	 			
 	 		]