Struct gapi_grpc::google::actions::sdk::v2::interactionmodel::prompt::StaticCanvasPrompt

pub struct StaticCanvasPrompt {
    pub url: String,
    pub data: Vec<Value>,
    pub suppress_mic: bool,
    pub send_state_data_to_canvas_app: bool,
    pub enable_full_screen: bool,
}

Represents a Interactive Canvas response to be sent to the user. This can be used in conjunction with the first_simple field in the containing prompt to speak to the user in addition to displaying a interactive canvas response.

Fields

url: String

Required. URL of the web view to load.

data: Vec<Value>

Optional. JSON data to be passed through to the immersive experience web page as an event. If the override field in the containing prompt is false data values defined in this Canvas prompt will be added after data values defined in previous Canvas prompts.

suppress_mic: bool

Optional. A true value means that the mic won’t be opened for capturing input after this immersive response is presented to the user.

send_state_data_to_canvas_app: bool

Optional. If true, conversation related metadata is included and send back to the canvas application.

enable_full_screen: bool

Optional. If true the canvas application occupies the full screen and won’t have a header at the top. A toast message will also be displayed on the loading screen that includes the Action’s display name, the developer’s name, and instructions for exiting the Action. Default value: false.

Trait Implementations

impl Clone for StaticCanvasPrompt

fn clone(&self) -> StaticCanvasPrompt

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StaticCanvasPrompt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StaticCanvasPrompt

fn default() -> StaticCanvasPrompt

Returns the “default value” for a type.

impl Message for StaticCanvasPrompt

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<StaticCanvasPrompt> for StaticCanvasPrompt

fn eq(&self, other: &StaticCanvasPrompt) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StaticCanvasPrompt) -> bool

This method tests for !=.

impl StructuralPartialEq for StaticCanvasPrompt