Struct remoteit_api::R3Client

pub struct R3Client { /* private fields */ }

A client for the remote.it API.

Example

You can instantiate a new R3Client using the builder pattern:

let credentials = Credentials::load_from_disk().call().unwrap().take_profile("default").unwrap().unwrap();
let client = R3Client::builder().credentials(credentials).build();
// Start making API calls
let devices = client.get_devices().call().unwrap();

Implementations

impl R3Client

pub async fn send_remoteit_graphql_request_async<V: Serialize, R: for<'a> Deserialize<'a>>( self, query_body: &QueryBody<V>, ) -> Result<Response<R>, Box<dyn Error>>

Sends a signed GraphQL request to the remote.it API in a blocking way.

You probably don’t want to use this function directly, but rather use the other functions in this module like R3Client::get_files().

Errors

• Any error that occurs during the request.
• Any error that occurs during deserialization of the response.

pub fn get_files_async(self) -> R3ClientGetFilesAsyncBuilder

Get a list of files that were uploaded to remote.it.

pub fn delete_file_async(self) -> R3ClientDeleteFileAsyncBuilder

Delete a file from remote.it. Deletes all versions of the file.

pub fn delete_file_version_async(self) -> R3ClientDeleteFileVersionAsyncBuilder

Delete a version of a file from remote.it. (Not the whole file)

pub fn start_job_async(self) -> R3ClientStartJobAsyncBuilder

Start scripting jobs on one or more devices.

pub fn cancel_job_async(self) -> R3ClientCancelJobAsyncBuilder

Cancel a job. See remote.it docs on more information on when jobs can be cancelled.

pub fn get_jobs_async(self) -> R3ClientGetJobsAsyncBuilder

Get a list of jobs that were started on remote.it.

pub fn get_application_types_async( self, ) -> R3ClientGetApplicationTypesAsyncBuilder

Get a list of application types that are available on remote.it.

pub fn get_devices_async(self) -> R3ClientGetDevicesAsyncBuilder

Get a list of devices.

impl R3Client

Impl block for blocking API calls.

pub fn send_remoteit_graphql_request<V: Serialize, R: for<'a> Deserialize<'a>>( self, query_body: &QueryBody<V>, ) -> Result<Response<R>, Box<dyn Error>>

Sends a signed GraphQL request to the remote.it API in a blocking way.

You probably don’t want to use this function directly, but rather use the other functions in this module like R3Client::get_files().

Errors

• Any error that occurs during the request.
• Any error that occurs during deserialization of the response.

pub fn get_files(self) -> R3ClientGetFilesBuilder

Get a list of files that were uploaded to remote.it.

pub fn delete_file(self) -> R3ClientDeleteFileBuilder

Delete a file from remote.it. Deletes all versions of the file.

pub fn delete_file_version(self) -> R3ClientDeleteFileVersionBuilder

Delete a version of a file from remote.it. (Not the whole file)

pub fn start_job(self) -> R3ClientStartJobBuilder

Start scripting jobs on one or more devices.

pub fn cancel_job(self) -> R3ClientCancelJobBuilder

Cancel a job. See remote.it docs on more information on when jobs can be cancelled.

pub fn get_jobs(self) -> R3ClientGetJobsBuilder

Get a list of jobs that were started on remote.it.

pub fn get_application_types(self) -> R3ClientGetApplicationTypesBuilder

Get a list of application types that are available on remote.it.

pub fn get_devices(self) -> R3ClientGetDevicesBuilder

Get a list of devices.

impl R3Client

pub fn builder() -> R3ClientBuilder

Use builder syntax to create an instance of R3Client

impl R3Client

pub fn credentials(&self) -> &Credentials

Returns

A reference to the credentials used by the client.