Commit ed5bc527 authored by Mehdi Achour's avatar Mehdi Achour

docs: fix links, use notes

parent c47cfec6
...@@ -195,7 +195,7 @@ var DeviceInfo = require('react-native-device-info'); ...@@ -195,7 +195,7 @@ var DeviceInfo = require('react-native-device-info');
| [getDeviceLocale()](#getdevicelocale) | `string` | ✅ | ✅ | ✅ | 0.7.0 | | [getDeviceLocale()](#getdevicelocale) | `string` | ✅ | ✅ | ✅ | 0.7.0 |
| [getDeviceName()](#getdevicename) | `string` | ✅ | ✅ | ✅ | ? | | [getDeviceName()](#getdevicename) | `string` | ✅ | ✅ | ✅ | ? |
| [getFirstInstallTime()](#getfirstinstalltime) | `number` | ❌ | ✅ | ❌ | 0.12.0 | | [getFirstInstallTime()](#getfirstinstalltime) | `number` | ❌ | ✅ | ❌ | 0.12.0 |
| [getFreeDiskStorage()](#getFreeDiskStorage) | `number` | ✅ | ✅ | ❌ | `next` | | [getFreeDiskStorage()](#getfreediskstorage) | `number` | ✅ | ✅ | ❌ | `next` |
| [getIPAddress()](#getipaddress) | `Promise<string>` | ❌ | ✅ | ❌ | 0.12.0 | | [getIPAddress()](#getipaddress) | `Promise<string>` | ❌ | ✅ | ❌ | 0.12.0 |
| [getInstanceID()](#getinstanceid) | `string` | ❌ | ✅ | ❌ | ? | | [getInstanceID()](#getinstanceid) | `string` | ❌ | ✅ | ❌ | ? |
| [getLastUpdateTime()](#getlastupdatetime) | `number` | ❌ | ✅ | ❌ | 0.12.0 | | [getLastUpdateTime()](#getlastupdatetime) | `number` | ❌ | ✅ | ❌ | 0.12.0 |
...@@ -209,7 +209,7 @@ var DeviceInfo = require('react-native-device-info'); ...@@ -209,7 +209,7 @@ var DeviceInfo = require('react-native-device-info');
| [getSystemName()](#getsystemname) | `string` | ✅ | ✅ | ✅ | ? | | [getSystemName()](#getsystemname) | `string` | ✅ | ✅ | ✅ | ? |
| [getSystemVersion()](#getsystemversion) | `string` | ✅ | ✅ | ✅ | ? | | [getSystemVersion()](#getsystemversion) | `string` | ✅ | ✅ | ✅ | ? |
| [getTimezone()](#gettimezone) | `string` | ✅ | ✅ | ✅ | ? | | [getTimezone()](#gettimezone) | `string` | ✅ | ✅ | ✅ | ? |
| [getTotalDiskCapacity()](#getTotalDiskCapacity) | `number` | ✅ | ✅ | ❌ | `next` | | [getTotalDiskCapacity()](#gettotaldiskcapacity) | `number` | ✅ | ✅ | ❌ | `next` |
| [getTotalMemory()](#gettotalmemory) | `number` | ✅ | ✅ | ❌ | 0.14.0 | | [getTotalMemory()](#gettotalmemory) | `number` | ✅ | ✅ | ❌ | 0.14.0 |
| [getUniqueID()](#getuniqueid) | `string` | ✅ | ✅ | ✅ | ? | | [getUniqueID()](#getuniqueid) | `string` | ✅ | ✅ | ✅ | ? |
| [getUserAgent()](#getuseragent) | `string` | ✅ | ✅ | ❌ | 0.7.0 | | [getUserAgent()](#getuseragent) | `string` | ✅ | ✅ | ❌ | 0.7.0 |
...@@ -393,8 +393,7 @@ const firstInstallTime = DeviceInfo.getFirstInstallTime(); ...@@ -393,8 +393,7 @@ const firstInstallTime = DeviceInfo.getFirstInstallTime();
### getFreeDiskStorage() ### getFreeDiskStorage()
Gets available storage size, in bytes Gets available storage size, in bytes.
(Android: Returns only available external storage size, not including internal)
**Examples** **Examples**
...@@ -405,6 +404,10 @@ const freeDiskStorage = DeviceInfo.getFreeDiskStorage(); ...@@ -405,6 +404,10 @@ const freeDiskStorage = DeviceInfo.getFreeDiskStorage();
// iOS: 17179869184 // iOS: 17179869184
``` ```
**Notes**
> Android: Returns only available external storage size, not including internal.
--- ---
### getIPAddress() ### getIPAddress()
...@@ -616,9 +619,10 @@ const timezone = DeviceInfo.getTimezone(); // "Africa/Tunis" ...@@ -616,9 +619,10 @@ const timezone = DeviceInfo.getTimezone(); // "Africa/Tunis"
``` ```
--- ---
### getTotalDiskCapacity() ### getTotalDiskCapacity()
Gets full disk storage size, in bytes Gets full disk storage size, in bytes.
**Examples** **Examples**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment