RootManager (library 2.0.5 API)

java.lang.Object
- com.chrisplus.rootmanager.RootManager

public class RootManager
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`copyFile(java.lang.String source, java.lang.String destinationDir)` Copy a file into destination dir.
`static RootManager`	`getInstance()`
`boolean`	`hasRooted()` Check if the device is rooted
`boolean`	`installBinary(java.lang.String filePath)` Install a binary file into "/system/bin/"
`Result`	`installPackage(java.lang.String apkPath)` Install an app on the device.
`Result`	`installPackage(java.lang.String apkPath, java.lang.String installLocation)` Install a app on the specific location.
`boolean`	`isProcessRunning(java.lang.String processName)` Check if a process is running.
`boolean`	`killProcessById(java.lang.String processID)` Kill a process by its process id.
`boolean`	`killProcessByName(java.lang.String processName)` Kill a process by its name.
`boolean`	`obtainPermission()` Try to obtain the root access.
`boolean`	`remount(java.lang.String path, java.lang.String mountType)` Remount file system.
`boolean`	`removeBinary(java.lang.String fileName)` Remove a binary from "/system/bin/"
`void`	`restartDevice()` Restart the device.
`Result`	`runBinary(java.lang.String path)` Run a binary file.
`Result`	`runBinBinary(java.lang.String binaryName)` Run a binary in "/system/bin/"
`Result`	`runCommand(java.lang.String command)` Run raw commands in default shell.
`boolean`	`screenCap(java.lang.String path)` Get screen shot.
`boolean`	`screenRecord(java.lang.String path)` Record screen for 30s.
`boolean`	`screenRecord(java.lang.String path, long bitRate, long time)` Record screen.
`Result`	`uninstallPackage(java.lang.String packageName)` Uninstall an app by its package name.
`Result`	`uninstallSystemApp(java.lang.String apkPath)` Uninstall a system app by its path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static RootManager getInstance()
```
  - hasRooted
```
public boolean hasRooted()
```
    Check if the device is rooted
    This function check if the system has SU file. Note that though SU file exits, it might not work.
    
    Returns:
    
    this device is rooted or not.
  - obtainPermission
```
public boolean obtainPermission()
```
    Try to obtain the root access.
    This function might lead to a popup to users, and wait for the input : grant or decline.
    
    Returns:
    
    the app has been granted the root permission or not.
  - installPackage
```
public Result installPackage(java.lang.String apkPath)
```
    Install an app on the device.
    do NOT call this function on UI thread, IllegalStateException will be thrown otherwise.
    
    Parameters:
    
    apkPath - the APK file path i.e., "/sdcard/Tech_test.apk" is OK. ASCII is supported.
    
    Returns:
    
    the result Result of running the command.
  - installPackage
```
public Result installPackage(java.lang.String apkPath,
                             java.lang.String installLocation)
```
    Install a app on the specific location.
    do NOT call this function on UI thread, IllegalStateException will be thrown otherwise.
    Parameters:
    
    apkPath - the APK file path i.e., "/sdcard/Tech_test.apk" is OK. ASCII is supported.
    installLocation - the location of this installation.
    
    auto: choose the install location automatically.
    
    ex: install the app on sdcard.
    
    in: install the app on ram
    Returns:
    
    the result Result of running the command.
  - uninstallPackage
```
public Result uninstallPackage(java.lang.String packageName)
```
    Uninstall an app by its package name.
    do NOT call this function on UI thread, IllegalStateException will be thrown otherwise.
    
    Parameters:
    
    packageName - the app's package name.
    
    Returns:
    
    the result Result of running the command.
  - uninstallSystemApp
```
public Result uninstallSystemApp(java.lang.String apkPath)
```
    Uninstall a system app by its path.
    do NOT call this function on UI thread, IllegalStateException will be thrown otherwise.
    
    Parameters:
    
    apkPath - the source apk path of the system app.
    
    Returns:
    
    the result Result of running the command.
  - installBinary
```
public boolean installBinary(java.lang.String filePath)
```
    Install a binary file into "/system/bin/"
    
    Parameters:
    
    filePath - The target of the binary file.
    
    Returns:
    
    the operation result.
  - removeBinary
```
public boolean removeBinary(java.lang.String fileName)
```
    Remove a binary from "/system/bin/"
    
    Parameters:
    
    fileName, - name of target file.
    
    Returns:
    
    the operation result.
  - copyFile
```
public boolean copyFile(java.lang.String source,
                        java.lang.String destinationDir)
```
    Copy a file into destination dir.
    
    Parameters:
    
    source - the source file path.
    
    destinationDir - the destination dir path.
    
    Returns:
    
    the operation result.
  - remount
```
public boolean remount(java.lang.String path,
                       java.lang.String mountType)
```
    Remount file system.
    
    Parameters:
    
    path - the path you want to remount
    
    mountType - the mount type, including, "ro", read only, "rw" , read and write
    
    Returns:
    
    the operation result.
  - runBinBinary
```
public Result runBinBinary(java.lang.String binaryName)
```
    Run a binary in "/system/bin/"
    
    Parameters:
    
    binaryName - the file name of binary, containing params if necessary.
    
    Returns:
    
    the result Result of running the command.
  - runBinary
```
public Result runBinary(java.lang.String path)
```
    Run a binary file.
    
    Parameters:
    
    path - the file path of binary, containing params if necessary.
    
    Returns:
    
    the result Result of running the command.
  - runCommand
```
public Result runCommand(java.lang.String command)
```
    Run raw commands in default shell.
    
    Parameters:
    
    command - the command string.
    
    Returns:
    
    the result Result of running the command.
  - screenCap
```
public boolean screenCap(java.lang.String path)
```
    Get screen shot.
    
    Parameters:
    
    path - the path with file name and extend name.
    
    Returns:
    
    the operation result.
  - screenRecord
```
public boolean screenRecord(java.lang.String path)
```
    Record screen for 30s. This function is ONLY supported on Android 4.4 and upper.
    
    Parameters:
    
    path - the path with file name and extend name.
    
    Returns:
    
    the operation result.
  - screenRecord
```
public boolean screenRecord(java.lang.String path,
                            long bitRate,
                            long time)
```
    Record screen. This function is ONLY supported on Android 4.4 and upper.
    
    Parameters:
    
    path - the path with file name and extend name.
    
    bitRate - the bate rate in bps, i.e., 4000000 for 4M bps.
    
    time - the recording time in seconds
    
    Returns:
    
    the operation result.
  - isProcessRunning
```
public boolean isProcessRunning(java.lang.String processName)
```
    Check if a process is running.
    
    Parameters:
    
    processName - the name of process. For user app, the process name is its package name.
    
    Returns:
    
    whether this process is running.
  - killProcessByName
```
public boolean killProcessByName(java.lang.String processName)
```
    Kill a process by its name.
    
    Parameters:
    
    processName - the name of this process. For user apps, the process name is its package name.
    
    Returns:
    
    the operation result.
  - killProcessById
```
public boolean killProcessById(java.lang.String processID)
```
    Kill a process by its process id.
    
    Parameters:
    
    processID - PID of the target process.
    
    Returns:
    
    the operation result.
  - restartDevice
```
public void restartDevice()
```
    Restart the device.

Class RootManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

hasRooted

obtainPermission

installPackage

installPackage

uninstallPackage

uninstallSystemApp

installBinary

removeBinary

copyFile

remount

runBinBinary

runBinary

runCommand

screenCap

screenRecord

screenRecord

isProcessRunning

killProcessByName

killProcessById

restartDevice