Struct gapi_grpc::google::actions::sdk::v2::conversation::Canvas

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

Represents an 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. The maximum size of the response is 50k bytes.

Fields

url: String

URL of the interactive canvas web app to load. If not set, the url from current active canvas will be reused.

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. Default value: false.

enable_full_screen: bool

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 Canvas

fn clone(&self) -> Canvas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Canvas

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

Formats the value using the given formatter.

impl Default for Canvas

fn default() -> Canvas

Returns the “default value” for a type.

impl Message for Canvas

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<Canvas> for Canvas

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

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

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

This method tests for !=.

impl StructuralPartialEq for Canvas