# ARSnova-client

An ARSnova live feedback client library

## Usage

### Initialize client and login

Create a client using and request guest login.

```rust
let client = Client::new("https://ars.particify.de/api").expect("client created");
let client = client.guest_login().await.expect("logged in");
```

### Request room information

The room information contains the name, ID and the 8-digit short ID of the requested room.

```rust
let room_info = client.get_room_info("12345678").await.expect("room information");
```

### Feedback

You can get feedback information in two different ways: Direct request and getting notified about changes.

#### Direct request

You can request (poll) the current feedback:

```rust
let feedback = client.get_feedback("12345678").await.expect("current feedback");
```

#### Getting notified

To handle feedback changes, you can use a handler function or forward the feedback to a channel.

Handle feedback changes using a function:

```rust
client.on_feedback_changed( & cli.room, FeedbackHandler::Fn(|feedback| {/*...*/})).await;
```

Forward feedback to a channel:

```rust
let (tx, rx) = tokio::sync::mpsc::channel::<Feedback>(10);

client.on_feedback_changed( & cli.room, FeedbackHandler::Sender(tx.clone())).await;
```

## Example

See [`examples/arsnova-client-tui.rs`](examples/arsnova-client-tui.rs) for a simple terminal-based feedback client
application.

### How to run

```shell
cargo run --example arsnova-client-tui
```

```
Terminal-based ARSnova live feedback client

Usage: arsnova-client-tui [OPTIONS] <ROOM>

Arguments:
  <ROOM>  Raum

Options:
  -u, --url <URL>  API-URL [default: https://ars.particify.de/api]
  -h, --help       Print help
  -V, --version    Print version
```

![arsnova-client-tui](examples/arsnova-client.gif)