rook_users
v0.4.0
Published
This SDK allows the [client](https://docs.tryrook.io/docs/Definitions/#client) to register their [Users](https://docs.tryrook.io/docs/Definitions/#User) in ROOK server.
Downloads
21
Readme
SDK Rook Users
This SDK allows the client to register their Users in ROOK server.
Features
- Register Users in Health Connect
Installation
npm
npm i rook_users react-native-mmkv
yarn
npm add rook_users react-native-mmkv
### Configuration
The package include a component call RookConnectProvider, it should preferably be used at the root of your component tree. RookConnectProvider needs the token that was given to you. import { RookConnectProvider } from 'rook_auth'
<RookConnectProvider
keys={{
clientUUID: 'YOUR-CLIENT-UUID',
apiURL: 'API-URL-ENVIROMENT',
password: 'YOUR-PASSWORD',
}}
>
<YOUR-COMPONENTS />
</RookConnectProvider>
Usage
The SDK provide you with a hook called useRookUser
this gives you the ability to check if you have an user ID generated or saved in the device.
Import
import { useRookUser } from 'rook_users';
Example
import React from 'react';
import { Button, SafeAreaView } from 'react-native';
import { useRookUser } from '../hooks/useRookUser';
export const Home = () => {
const {
ready,
getUserID,
registerUser,
clearUserID,
removeUserFromRook,
} = useRookUser();
const handleSaved = async (): Promise<void> => {
try {
console.log(ready);
const resp = await getUserID();
console.log('r', resp);
} catch (error) {
console.log(error);
}
};
const handleRegister = async (): Promise<void> => {
try {
console.log(ready);
const resp = await registerUser({
user: '9608762',
dataSource: 'Health Connect',
});
console.log(resp);
} catch (error) {
console.log(error);
}
};
const handleClearUserID = async (): Promise<void> => {
try {
console.log(ready);
clearUserID();
console.log(true);
} catch (error) {
console.log(error);
}
};
const handleRemoveUser = async (): Promise<void> => {
try {
console.log(ready);
const resp = await removeUserFromRook({
user: '9608762',
dataSource: 'Health Connect',
});
console.log(resp);
} catch (error) {
console.log(error);
}
};
return (
<SafeAreaView>
<Button title="Get saved id" onPress={handleSaved} />
<Button title="Register user" onPress={handleRegister} />
<Button title="Clear user" onPress={handleClearUserID} />
<Button title="Remove user" onPress={handleRemoveUser} />
</SafeAreaView>
);
};
API
const useRookUser: () => useRookUserTools;
Return
useRookUserTools
: Return two functions to manage the registration of the useruseRookUserTools.getUserID
: Return a null if you don't have a user saved in the device or will return the user that was saved.useRookUserTools.registerUser
: Register a user into Rook servicesuseRookUserTools.clearUserID
: Remove the user from LOCAL STORAGEuseRookUserTools.removeUserFromRook
: Remove the user from ROOK SERVICES