Struct Action

pub struct Action<'a> {
    pub data: ActionData,
    /* private fields */
}

A Quick Action setup in the Hive account.

Fields

data: ActionData

Implementations

impl Action<'_>

pub async fn activate(&self) -> Result<bool, ApiError>

Activate the Quick Actions.

Examples

use hive_client::authentication::{TrustedDevice, User};
let client = hive_client::Client::new("Home Automation").await;

let trusted_device = Some(TrustedDevice::new(
    "device_password",
    "device_group_key",
    "device_key"
));

client.login(User::new("example@example.com", "example", trusted_device))
    .await
    .expect("Login should succeed");

let actions = client.get_actions()
    .await
    .expect("Quick action should be retrieved");

// Activate a quick action
let mut turn_off_heating = actions.into_iter()
    .find(|action| action.data.id == "1234-5678-000-0000")
    .expect("Quick action to turn off heating should exist");

let activated = turn_off_heating.activate().await;

assert!(activated.is_ok());

Errors

Returns an error if the Quick Actions could not be activated.

Trait Implementations

impl Debug for Action<'_>

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

Formats the value using the given formatter.