Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add function details #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,55 @@ logger.e(e,stacktrace); // Use StackTrace.current in case no stacktrace availabl

```
logger.i("Api response: xyz");
```
```

## Functions

1. `Device_Info`: used to get details of device, namely:

- `brand`
- `manufacturer`
- `model`
- `os`
- `sdk`
- `id`
- `imei`
<br><br>
Also contains three subclasses:
- `IosDeviceInfoImpl`: For IOS devices
- `AndroidDeviceInfoImpl`: For Android devices
- `UnknownDeviceInfoImpl`: For other devices
<br><br>

2. `Package_Info`: used to get details of package and application, namely:

- `appName`
- `packageName`
- `version`
- `buildNumber`
<br><br>
`PackageInformationImpl` class defined here contains `getPackageInfo` function that returns all package and app details if detected platform:
`isMobile` or else returns "NA' in all fields.
<br><br>

3. `System_Info`: used to combine device and package details to get system details, namely:

- `version`
- `appName`
- `packageName`
- `buildNumber`
- `brand`
- `id`
- `manufacturer`
- `model`
- `os`
- `sdk`
- `imei`
<br><br>

4. `Platform_Utils`: used to check the platform on which the application is running. Platforms include:
- `Debug`
- `Mobile` (includes `Web`, `Android` and `IOS`)
- `Linux`
- `Mac`
- `Windows`