Struct Instance 

pub struct Instance {
    pub action_uuid: String,
    pub instance_id: InstanceId,
    pub device_id: String,
    pub controller: String,
    pub coordinates: Coordinates,
    pub is_in_multi_action: bool,
    pub current_state_index: u16,
    /* private fields */
}

An instance of an action bound to the device surface

Fields

action_uuid: String

The UUID of the action this is an instance of

instance_id: InstanceId

An ID that uniquely identifies this instance

device_id: String

The device this instance is bound to

controller: String

The controller this instance is bound to

coordinates: Coordinates

Coordinates on the device surface where this instance is bound

is_in_multi_action: bool

Whether or not this instance is part of a Multi Action

current_state_index: u16

Index of the currently active state within the states defined in the plugin manifest

Implementations

impl Instance

pub async fn set_title(&self, title: impl Into<String>) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/states.html#settitle

pub async fn set_image(&self, image: impl Into<String>) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/states.html#setimage

pub async fn set_state(&self, state: u16) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/states.html#setstate

pub async fn show_alert(&self) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/misc.html#showalert

pub async fn show_ok(&self) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/misc.html#showok

pub async fn set_settings(&self, value: &impl Serialize) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/settings.html#setsettings

pub async fn get_settings(&self) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/settings.html#getsettings

pub async fn send_to_property_inspector( &self, value: impl Serialize, ) -> Result<()>

https://openaction.amankhanna.me/5_serverbound/property_inspector.html#sendtopropertyinspector