Struct Account 

pub struct Account { /* private fields */ }

The main object for all user interactions and data manipulation, representing an authenticated user account.

Implementations

impl Account

pub fn is_etebase_server(client: &Client) -> Result<bool>

👎Deprecated: Use Client::is_server_valid instead

Check whether the Client is pointing to a valid Etebase server

Arguments:

• client - the already setup Client object

pub fn signup(client: Client, user: &User, password: &str) -> Result<Self>

Creates a new user on the server and returns a handle to it. The user is authenticated using the given password.

pub fn signup_key(client: Client, user: &User, main_key: &[u8]) -> Result<Self>

Creates a new user on the server and returns a handle to it. The user is authenticated using a cryptographically secure random 32-byte main_key instead of a password.

pub fn login(client: Client, username: &str, password: &str) -> Result<Self>

Authenticates a user using their password and returns an Account handle on success.

Examples found in repository

examples/etebase_test.rs (line 35)

fn main() -> Result<()> {
    let args: Vec<String> = env::args().collect();

    if args.len() < 4 {
        println!("Help: ./etebase_test USERNAME PASSWORD SERVER_URL [COLLECTION_UID]");
        std::process::exit(1);
    }

    let username = &args[1];
    let password = &args[2];
    let server_url = &args[3];

    let client = Client::new(CLIENT_NAME, server_url)?;
    let etebase = Account::login(client, username, password)?;
    let col_mgr = etebase.collection_manager()?;
    if args.len() >= 5 {
        let col_uid = &args[4];
        let col = col_mgr.fetch(col_uid, None)?;
        let it_mgr = col_mgr.item_manager(&col)?;
        let items = it_mgr.list(None)?;

        print_collection(&col);
        for item in items.data() {
            print_item(item);
        }
    } else {
        let collections = col_mgr.list("some.coltype", None)?;
        for col in collections.data() {
            print_collection(col);
        }
    }

    etebase.logout()?;

    Ok(())
}

pub fn login_key( client: Client, username: &str, main_key: &[u8], ) -> Result<Self>

Authenticates a user using the same main_key as was provided to signup_key and returns an Account handle on success.

pub fn fetch_token(&mut self) -> Result<()>

Fetch a new auth token for the account and update the Account object with it

pub fn force_server_url(&mut self, api_base: &str) -> Result<()>

Change the server URL for this account handle

See also Client::set_server_url.

pub fn change_password(&mut self, new_password: &str) -> Result<()>

Change the user’s login password. If the account currently uses key-based login, the key is invalidated and subsequent logins have to use the password.

pub fn fetch_dashboard_url(&self) -> Result<String>

Fetch the link to the user dashboard of the account

pub fn logout(&self) -> Result<()>

Logout the user from the current session and invalidate the authentication token

Examples found in repository

examples/etebase_test.rs (line 54)

fn main() -> Result<()> {
    let args: Vec<String> = env::args().collect();

    if args.len() < 4 {
        println!("Help: ./etebase_test USERNAME PASSWORD SERVER_URL [COLLECTION_UID]");
        std::process::exit(1);
    }

    let username = &args[1];
    let password = &args[2];
    let server_url = &args[3];

    let client = Client::new(CLIENT_NAME, server_url)?;
    let etebase = Account::login(client, username, password)?;
    let col_mgr = etebase.collection_manager()?;
    if args.len() >= 5 {
        let col_uid = &args[4];
        let col = col_mgr.fetch(col_uid, None)?;
        let it_mgr = col_mgr.item_manager(&col)?;
        let items = it_mgr.list(None)?;

        print_collection(&col);
        for item in items.data() {
            print_item(item);
        }
    } else {
        let collections = col_mgr.list("some.coltype", None)?;
        for col in collections.data() {
            print_collection(col);
        }
    }

    etebase.logout()?;

    Ok(())
}

pub fn save(&self, encryption_key: Option<&[u8]>) -> Result<String>

Serializes the account object to a string for restoring it later using restore.

The data should be encrypted using a 32-byte encryption_key for added security.

pub fn restore( client: Client, account_data_stored: &str, encryption_key: Option<&[u8]>, ) -> Result<Self>

Deserialize and return the Account object from the string obtained using save.

Arguments:

• client - the already setup Client object
• account_data_stored - the stored account string
• encryption_key - the same encryption key passed to save while saving the account

pub fn collection_manager(&self) -> Result<CollectionManager>

Return a CollectionManager for creating, fetching and uploading collections

Examples found in repository

examples/etebase_test.rs (line 36)

fn main() -> Result<()> {
    let args: Vec<String> = env::args().collect();

    if args.len() < 4 {
        println!("Help: ./etebase_test USERNAME PASSWORD SERVER_URL [COLLECTION_UID]");
        std::process::exit(1);
    }

    let username = &args[1];
    let password = &args[2];
    let server_url = &args[3];

    let client = Client::new(CLIENT_NAME, server_url)?;
    let etebase = Account::login(client, username, password)?;
    let col_mgr = etebase.collection_manager()?;
    if args.len() >= 5 {
        let col_uid = &args[4];
        let col = col_mgr.fetch(col_uid, None)?;
        let it_mgr = col_mgr.item_manager(&col)?;
        let items = it_mgr.list(None)?;

        print_collection(&col);
        for item in items.data() {
            print_item(item);
        }
    } else {
        let collections = col_mgr.list("some.coltype", None)?;
        for col in collections.data() {
            print_collection(col);
        }
    }

    etebase.logout()?;

    Ok(())
}

pub fn invitation_manager(&self) -> Result<CollectionInvitationManager>

Return a CollectionInvitationManager for managing collection invitations