Struct lifxi::http::Client

pub struct Client { /* private fields */ }

The crux of the HTTP API. Start here.

The client is the entry point for the web API interface. First construct a client, then use it to perform whatever tasks necessary.

Example

use lifxi::http::prelude::*;
let client = Client::new("foo");
let result = client
    .select(Selector::All)
    .set_state()
    .color(Color::Red)
    .power(true)
    .retry()
    .send();

Implementations

impl Client

pub fn new<S: ToString>(token: S) -> Self

Constructs a new Client with the given access token.

Examples

use lifxi::http::prelude::*;
let secret = "foo";
let client = Client::new(secret);
let secret = "foo".to_string();
let client = Client::new(secret);

pub fn select<T: Select>(&self, selector: T) -> Selected<'_, T>

Specifies the lights upon which to act.

See the documentation for Selected<T> to understand why this is useful.

pub fn set_states(&self) -> SetStates<'_>

Creates a request to set multiple states (on multiple lights).

For a simpler API when working with a single state on one or multiple lights, see Selected::set_state.

pub fn validate(&self, color: &Color) -> Request<'_, ()>

Creates a request to validate the given color.

Example

use lifxi::http::prelude::*;
let secret = "foo";
let client = Client::new(secret);
let color = Color::Custom("cyan".to_string());
let is_valid = client
    .validate(&color)
    .send()
    .is_ok();

pub fn scenes(&self) -> Scenes<'_>

Entry point for working with scenes.

See Scenes.