LibXposed API

https://libxposed.github.io/api
Admin
LibXposed API provides interfaces and classes for developing modules and interacting with the Xposed...
Tokens:14,420
Snippets:86
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Accessing Arguments with XposedInterface.Chain (Java)

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Chain.html

Demonstrates how to retrieve arguments from an interceptor chain using XposedInterface.Chain. This includes getting all arguments or a specific argument by index. It also shows how to proceed with the chain using the original or modified arguments.

```Java
Object getArg(int index) throws IndexOutOfBoundsException, ClassCastException
Object getArgs()
Object proceed(Object[] args) throws Throwable
```

--------------------------------

### getModuleApplicationInfo

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Gets the application info of the module.

```APIDOC
## getModuleApplicationInfo

### Description
Gets the application info of the module.

### Response
- **ApplicationInfo** (Object) - The application info of the module
```

--------------------------------

### Retrieving Hooked Executable Information with XposedInterface.Chain (Java)

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Chain.html

Shows how to obtain information about the method or constructor being hooked using the XposedInterface.Chain. This includes getting the `Executable` object itself and the `this` pointer for the current call, which is null for static methods.

```Java
Executable getExecutable()
Object getThisObject()
```

--------------------------------

### getRemotePreferences

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Gets remote preferences stored in Xposed framework.

```APIDOC
## getRemotePreferences

### Description
Gets remote preferences stored in Xposed framework. Note that those are read-only in hooked apps.

### Parameters
#### Query Parameters
- **name** (String) - Required - Group name

### Response
- **SharedPreferences** (Object) - The preferences
```

--------------------------------

### Get Method and Constructor Invokers

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Retrieves invokers to bypass access checks for methods or constructors.

```java
@NonNull public final XposedInterface.Invoker<?,Method> getInvoker(@NonNull Method method)
```

```java
@NonNull public final <T> XposedInterface.CtorInvoker<T> getInvoker(@NonNull Constructor<T> constructor)
```

--------------------------------

### Instantiate and Use Chain Record

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.Type.Chain.html

Demonstrates how to create an instance of the Chain record to define a maximum hook priority and access the configured value.

```java
import io.github.libxposed.api.XposedInterface;

// Create a chain instance with a max priority of 100
XposedInterface.Invoker.Type.Chain chain = new XposedInterface.Invoker.Type.Chain(100);

// Access the maxPriority value
int priority = chain.maxPriority();

// Use the predefined FULL constant for full chain execution
XposedInterface.Invoker.Type.Chain fullChain = XposedInterface.Invoker.Type.Chain.FULL;
```

--------------------------------

### XposedInterface Overview

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Provides an overview of the XposedInterface, its purpose, and known implementing classes.

```APIDOC
## XposedInterface

### Description
Xposed interface for modules to operate on application processes.

### Known Implementing Classes
- `XposedInterfaceWrapper`
- `XposedModule`
```

--------------------------------

### Framework Information Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Methods to retrieve metadata about the current Xposed framework implementation.

```APIDOC
## GET /framework/info

### Description
Retrieves various metadata about the running Xposed framework.

### Methods
- getApiVersion(): int - Gets the runtime Xposed API version.
- getFrameworkName(): String - Gets the Xposed framework name.
- getFrameworkVersion(): String - Gets the Xposed framework version.
- getFrameworkVersionCode(): long - Gets the Xposed framework version code.
- getFrameworkProperties(): long - Gets the Xposed framework properties.
```

--------------------------------

### Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Summary of the methods available in the XposedInterface.

```APIDOC
## Methods

### `deoptimize(Executable executable)`
**Modifier:** `public`
**Returns:** `boolean`
**Description:** Deoptimizes a method / constructor in case hooked callee is not called because of inline.

### `getApiVersion()`
**Modifier:** `default`
**Returns:** `int`
**Description:** Gets the runtime Xposed API version.

### `getFrameworkName()`
**Modifier:** `public`
**Returns:** `String`
**Description:** Gets the Xposed framework name of current implementation.

### `getFrameworkProperties()`
**Modifier:** `public`
**Returns:** `long`
**Description:** Gets the Xposed framework properties.

### `getFrameworkVersion()`
**Modifier:** `public`
**Returns:** `String`
**Description:** Gets the Xposed framework version of current implementation.

### `getFrameworkVersionCode()`
**Modifier:** `public`
**Returns:** `long`
**Description:** Gets the Xposed framework version code of current implementation.

### `getInvoker(Constructor<T> constructor)`
**Modifier:** `<T>`
**Returns:** `XposedInterface.CtorInvoker<T>`
**Description:** Get a constructor invoker for the given constructor.

### `getInvoker(Method method)`
**Returns:** `XposedInterface.Invoker<?, Method>`
**Description:** Get a method invoker for the given method.

### `getModuleApplicationInfo()`
**Modifier:** `public`
**Returns:** `ApplicationInfo`
**Description:** Gets the application info of the module.

### `getRemotePreferences(String group)`
**Modifier:** `public`
**Returns:** `SharedPreferences`
**Description:** Gets remote preferences stored in Xposed framework.

### `hook(Executable origin)`
**Modifier:** `public`
**Returns:** `XposedInterface.HookBuilder`
**Description:** Hook a method / constructor.

### `hookClassInitializer(Class<?> origin)`
**Modifier:** `public`
**Returns:** `XposedInterface.HookBuilder`
**Description:** Hook the static initializer (`<clinit>`) of a class.

### `listRemoteFiles()`
**Modifier:** `public`
**Returns:** `String[]`
**Description:** List all files in the module's shared data directory.

### `log(int priority, String tag, String msg)`
**Modifier:** `public`
**Returns:** `void`
**Description:** Writes a message to the Xposed log.

### `log(int priority, String tag, String msg, Throwable tr)`
**Modifier:** `public`
**Returns:** `void`
**Description:** Writes a message to the Xposed log.

### `openRemoteFile(String name)`
**Modifier:** `public`
**Returns:** `ParcelFileDescriptor`
**Description:** Open a file in the module's shared data directory.
```

--------------------------------

### Module Initialization Parameters

Source: https://libxposed.github.io/api/io/github/libxposed/api/package-summary.html

Details on the parameters provided during module lifecycle events.

```APIDOC
## Module Lifecycle Parameters

### Description
Information provided to modules during various initialization stages.

### Parameters
- **ModuleLoadedParam**: Wraps information about the process in which the module is loaded.
- **PackageLoadedParam**: Wraps information about the package being loaded.
- **PackageReadyParam**: Wraps information about the package whose classloader is ready.
- **SystemServerStartingParam**: Wraps information about the system server startup.
```

--------------------------------

### Instantiating and Using Origin Record

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.Type.Origin.html

Demonstrates how to instantiate the Origin record class. This class is typically used to signal the LibXposed framework to bypass existing hooks during method invocation.

```java
import io.github.libxposed.api.XposedInterface;

// Creating an instance of the Origin record
XposedInterface.Invoker.Type.Origin origin = new XposedInterface.Invoker.Type.Origin();

// The record implements standard Object methods
String representation = origin.toString();
int hash = origin.hashCode();
boolean isEqual = origin.equals(new XposedInterface.Invoker.Type.Origin());
```

--------------------------------

### Retrieve Framework Information

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Methods to retrieve versioning, naming, and property information from the Xposed framework.

```java
public final int getApiVersion()
```

```java
@NonNull public final String getFrameworkName()
```

```java
@NonNull public final String getFrameworkVersion()
```

```java
public final long getFrameworkVersionCode()
```

```java
public final long getFrameworkProperties()
```

--------------------------------

### Logging and Preferences

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Methods for logging to the Xposed log and accessing remote preferences.

```APIDOC
## POST /log

### Description
Writes a message to the Xposed log.

### Parameters
- priority (int) - Required - Log priority.
- tag (String) - Optional - Log tag.
- msg (String) - Required - Log message.
- tr (Throwable) - Optional - Exception to log.

## GET /preferences

### Description
Retrieves remote preferences stored in the Xposed framework.

### Parameters
- group (String) - Required - Group name.
```

--------------------------------

### Logging and Utilities

Source: https://libxposed.github.io/api/index-all.html

Utility methods for logging to the Xposed log and managing module data.

```APIDOC
## log(int, String, String)

### Description
Writes a message to the Xposed log.

## log(int, String, String, Throwable)

### Description
Writes a message to the Xposed log with an associated exception.

## listRemoteFiles()

### Description
List all files in the module's shared data directory.
```

--------------------------------

### XposedInterface Methods

Source: https://libxposed.github.io/api/index-all.html

Methods for retrieving framework information and module-specific details.

```APIDOC
## GET getApiVersion()

### Description
Gets the runtime Xposed API version.

## GET getFrameworkName()

### Description
Gets the Xposed framework name of current implementation.

## GET getFrameworkProperties()

### Description
Gets the Xposed framework properties.

## GET getFrameworkVersion()

### Description
Gets the Xposed framework version of current implementation.

## GET getFrameworkVersionCode()

### Description
Gets the Xposed framework version code of current implementation.

## GET getModuleApplicationInfo()

### Description
Gets the application info of the module.
```

--------------------------------

### Fields

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Summary of the static fields available in the XposedInterface.

```APIDOC
## Fields

### `API_101`
**Type:** `static final int`
**Description:** This is the first API version. Behavior changes: Modules targeting 101 or higher. Modules cannot be injected into zygote; they are only loaded within the process of the scope.

### `LIB_API`
**Type:** `static final int`
**Description:** The API version of this library.

### `PRIORITY_DEFAULT`
**Type:** `static final int`
**Description:** The default hook priority.

### `PRIORITY_HIGHEST`
**Type:** `static final int`
**Description:** Execute at the beginning of the interception chain.

### `PRIORITY_LOWEST`
**Type:** `static final int`
**Description:** Execute at the end of the interception chain.

### `PROP_CAP_REMOTE`
**Type:** `static final long`
**Description:** The framework provides remote preferences and remote files support.

### `PROP_CAP_SYSTEM`
**Type:** `static final long`
**Description:** The framework has the capability to hook system_server and other system processes.

### `PROP_RT_API_PROTECTION`
**Type:** `static final long`
**Description:** The framework disallows accessing Xposed API via reflection or dynamically loaded code.
```

--------------------------------

### Hook Methods and Initializers

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Methods for hooking executables or class static initializers.

```java
@NonNull public final XposedInterface.HookBuilder hook(@NonNull Executable origin)
```

```java
@NonNull public final XposedInterface.HookBuilder hookClassInitializer(@NonNull Class<?> origin)
```

--------------------------------

### Package and Module Parameters

Source: https://libxposed.github.io/api/index-all.html

Methods for accessing package-specific information during module loading.

```APIDOC
## GET getAppComponentFactory()

### Description
Gets the AppComponentFactory of the current package (PackageReadyParam).

## GET getApplicationInfo()

### Description
Gets the ApplicationInfo of the current package (PackageLoadedParam).

## GET getClassLoader()

### Description
Gets the classloader of the current package or system server.

## GET getPackageName()

### Description
Gets the package name of the current package (PackageLoadedParam).

## GET getProcessName()

### Description
Gets the process name (ModuleLoadedParam).
```

--------------------------------

### Xposed Module and Related Classes

Source: https://libxposed.github.io/api/allclasses-index.html

Classes related to Xposed module development and initialization.

```APIDOC
## XposedModule

### Description
Super class which all Xposed module entry classes should extend. Entry classes will be instantiated exactly once for each process.

### Class
`XposedModule`

## XposedModuleInterface

### Description
Interface for module initialization.

### Class
`XposedModuleInterface`

## XposedModuleInterface.ModuleLoadedParam

### Description
Wraps information about the process in which the module is loaded.

### Class
`XposedModuleInterface.ModuleLoadedParam`

## XposedModuleInterface.PackageLoadedParam

### Description
Wraps information about the package being loaded.

### Class
`XposedModuleInterface.PackageLoadedParam`

## XposedModuleInterface.PackageReadyParam

### Description
Wraps information about the package whose classloader is ready.

### Class
`XposedModuleInterface.PackageReadyParam`

## XposedModuleInterface.SystemServerStartingParam

### Description
Wraps information about system server.

### Class
`XposedModuleInterface.SystemServerStartingParam`
```

--------------------------------

### Field Details

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Detailed explanations for specific fields within XposedInterface.

```APIDOC
## Field Details

### `API_101`
**Type:** `static final int`
**Description:** Behavior changes: all modules Modules cannot be injected into zygote; they are only loaded within the process of the scope. Behavior changes: Modules targeting 101 or higher This is the first API version.

### `LIB_API`
**Type:** `static final int`
**Description:** The API version of this **library**.

### `PROP_CAP_SYSTEM`
**Type:** `static final long`
**Description:** The framework has the capability to hook system_server and other system processes.

### `PROP_CAP_REMOTE`
**Type:** `static final long`
**Description:** The framework provides remote preferences and remote files support.

### `PROP_RT_API_PROTECTION`
**Type:** `static final long`
**Description:** The framework disallows accessing Xposed API via reflection or dynamically loaded code.

### `PRIORITY_DEFAULT`
**Type:** `static final int`
**Description:** The default hook priority.

### `PRIORITY_LOWEST`
**Type:** `static final int`
**Description:** Execute at the end of the interception chain.
```

--------------------------------

### Accessing the ORIGIN constant

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.Type.html

Demonstrates how to access the predefined ORIGIN constant, which is used to invoke the original executable while skipping all registered hooks.

```java
import XposedInterface.Invoker.Type;

// Accessing the convenience constant
Type invokerType = Type.ORIGIN;
```

--------------------------------

### Hooking Methods

Source: https://libxposed.github.io/api/index-all.html

Methods for hooking class initializers and executables within the Xposed framework.

```APIDOC
## hook(Executable)

### Description
Hook a method or constructor.

### Method
Interface Method

### Parameters
- **executable** (Executable) - Required - The method or constructor to hook.

## hookClassInitializer(Class<?>)

### Description
Hook the static initializer (<clinit>) of a class.

### Method
Interface Method

### Parameters
- **clazz** (Class<?>) - Required - The class whose static initializer is to be hooked.
```

--------------------------------

### Initialize XposedInterfaceWrapper

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Constructor for the XposedInterfaceWrapper class.

```java
public XposedInterfaceWrapper()
```

--------------------------------

### log

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Writes a message to the Xposed log.

```APIDOC
## log

### Description
Writes a message to the Xposed log.

### Parameters
#### Request Body
- **priority** (int) - Required - The log priority
- **tag** (String) - Optional - The log tag
- **msg** (String) - Required - The log message
- **tr** (Throwable) - Optional - An exception to log
```

--------------------------------

### XposedInterface.Invoker Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.html

Details the methods available on the XposedInterface.Invoker interface for invoking methods and constructors.

```APIDOC
## XposedInterface.Invoker<T, U>

### Description
Invoker for a method or constructor. Invocations through invokers will bypass access checks.

### Nested Class Summary

#### Interface XposedInterface.Invoker.Type
Type of the invoker, which determines the hook chain to be invoked.

### Method Summary

#### Instance Methods

##### `Object invoke(Object thisObject, Object... args)`
Invokes the method (or the constructor as a method) through the hook chain determined by the invoker's type.

Parameters:
- `thisObject` (Object) - For non-static calls, the `this` pointer, otherwise `null`.
- `args` (Object...) - The arguments used for the method call.

Returns:
The result returned from the invoked method. For void methods and constructors, always returns `null`.

Throws:
- `InvocationTargetException`
- `IllegalArgumentException`
- `IllegalAccessException`

See Also:
- `Method.invoke(Object, Object...)`

##### `Object invokeSpecial(Object thisObject, Object... args)`
Invokes the special (non-virtual) method (or the constructor as a method) on a given object instance, similar to the functionality of `CallNonVirtual<type>Method` in JNI, which invokes an instance (nonstatic) method on a Java object. This method is useful when you need to call a specific method on an object, bypassing any overridden methods in subclasses and directly invoking the method defined in the specified class. This method is useful when you need to call `super.xxx()` in a hooked constructor.

Parameters:
- `thisObject` (Object) - The `this` pointer.
- `args` (Object...) - The arguments used for the method call.

Returns:
The result returned from the invoked method. For void methods and constructors, always returns `null`.

Throws:
- `InvocationTargetException`
- `IllegalArgumentException`
- `IllegalAccessException`

See Also:
- `Method.invoke(Object, Object...)`

##### `T setType(XposedInterface.Invoker.Type type)`
Sets the type of the invoker, which determines the hook chain to be invoked.

Parameters:
- `type` (XposedInterface.Invoker.Type) - The type of the invoker.

Returns:
The invoker instance with the type set.
```

--------------------------------

### XposedInterface Constants

Source: https://libxposed.github.io/api/constant-values.html

Definitions of API versions, priority levels, and capability properties used within the LibXposed framework.

```APIDOC
## io.github.libxposed.api.XposedInterface

### Description
Provides constant values for API versioning, module priority, and system capabilities.

### Constants
- **API_101** (int) - 101
- **LIB_API** (int) - 101
- **PRIORITY_DEFAULT** (int) - 50
- **PRIORITY_HIGHEST** (int) - 2147483647
- **PRIORITY_LOWEST** (int) - -2147483648
- **PROP_CAP_REMOTE** (long) - 2L
- **PROP_CAP_SYSTEM** (long) - 1L
- **PROP_RT_API_PROTECTION** (long) - 4L
```

--------------------------------

### Invoking Methods via XposedInterface.Invoker

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.html

Demonstrates how to use the invoke method to execute a method through the hook chain. It requires the target object instance and an array of arguments.

```java
Object result = invoker.invoke(targetObject, arg1, arg2);

```

--------------------------------

### Xposed Interface and Related Classes

Source: https://libxposed.github.io/api/allclasses-index.html

Core interfaces and helper classes for interacting with the Xposed framework and application processes.

```APIDOC
## XposedInterface

### Description
Xposed interface for modules to operate on application processes.

### Class
`XposedInterface`

## XposedInterface.Chain

### Description
Interceptor chain for a method or constructor.

### Class
`XposedInterface.Chain`

## XposedInterface.CtorInvoker<T>

### Description
Invoker for a constructor.

### Class
`XposedInterface.CtorInvoker<T>`

## XposedInterface.ExceptionMode

### Description
Exception handling mode for hookers.

### Class
`XposedInterface.ExceptionMode`

## XposedInterface.HookBuilder

### Description
Builder for configuring a hook.

### Class
`XposedInterface.HookBuilder`

## XposedInterface.Hooker

### Description
Hooker for a method or constructor.

### Class
`XposedInterface.Hooker`

## XposedInterface.HookHandle

### Description
Handle for a hook.

### Class
`XposedInterface.HookHandle`

## XposedInterface.Invoker<T,U>

### Description
Invoker for a method or constructor.

### Class
`XposedInterface.Invoker<T,U>`

## XposedInterface.Invoker.Type

### Description
Type of the invoker, which determines the hook chain to be invoked.

### Class
`XposedInterface.Invoker.Type`

## XposedInterface.Invoker.Type.Chain

### Description
Invokes the executable starting from the middle of the hook chain, skipping all hooks with priority higher than the given value.

### Class
`XposedInterface.Invoker.Type.Chain`

## XposedInterface.Invoker.Type.Origin

### Description
Invokes the original executable, skipping all hooks.

### Class
`XposedInterface.Invoker.Type.Origin`
```

--------------------------------

### XposedInterfaceWrapper Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

This section details the various methods available in the XposedInterfaceWrapper class for interacting with the Xposed framework.

```APIDOC
## XposedInterfaceWrapper Methods

### Description
Provides methods for modules to interact with the Xposed framework, including framework attachment, method deoptimization, API and framework information retrieval, hooking capabilities, module information access, remote preferences management, logging, and file operations.

### Methods

#### `attachFramework(XposedInterface base)`
*   **Description**: Attaches the framework interface to the module.
*   **Modifier**: `final`
*   **Return Type**: `void`

#### `deoptimize(Executable executable)`
*   **Description**: Deoptimizes a method or constructor if the hooked callee is not called due to inlining.
*   **Modifier**: `final`
*   **Return Type**: `boolean`
*   **Parameters**:
    *   `executable` (Executable) - The method or constructor to deoptimize.

#### `getApiVersion()`
*   **Description**: Gets the runtime Xposed API version.
*   **Modifier**: `final`
*   **Return Type**: `int`

#### `getFrameworkName()`
*   **Description**: Gets the Xposed framework name of the current implementation.
*   **Modifier**: `final`
*   **Return Type**: `String`

#### `getFrameworkProperties()`
*   **Description**: Gets the Xposed framework properties.
*   **Modifier**: `final`
*   **Return Type**: `long`

#### `getFrameworkVersion()`
*   **Description**: Gets the Xposed framework version of the current implementation.
*   **Modifier**: `final`
*   **Return Type**: `String`

#### `getFrameworkVersionCode()`
*   **Description**: Gets the Xposed framework version code of the current implementation.
*   **Modifier**: `final`
*   **Return Type**: `long`

#### `getInvoker(Constructor<T> constructor)`
*   **Description**: Get a constructor invoker for the given constructor.
*   **Modifier**: `final`
*   **Return Type**: `XposedInterface.CtorInvoker<T>`
*   **Parameters**:
    *   `constructor` (Constructor<T>) - The constructor to get an invoker for.

#### `getInvoker(Method method)`
*   **Description**: Get a method invoker for the given method.
*   **Modifier**: `final`
*   **Return Type**: `XposedInterface.Invoker<?,Method>`
*   **Parameters**:
    *   `method` (Method) - The method to get an invoker for.

#### `getModuleApplicationInfo()`
*   **Description**: Gets the application info of the module.
*   **Modifier**: `final`
*   **Return Type**: `ApplicationInfo`

#### `getRemotePreferences(String name)`
*   **Description**: Gets remote preferences stored in Xposed framework.
*   **Modifier**: `final`
*   **Return Type**: `SharedPreferences`
*   **Parameters**:
    *   `name` (String) - The name of the preferences to retrieve.

#### `hook(Executable origin)`
*   **Description**: Hook a method or constructor.
*   **Modifier**: `final`
*   **Return Type**: `XposedInterface.HookBuilder`
*   **Parameters**:
    *   `origin` (Executable) - The method or constructor to hook.

#### `hookClassInitializer(Class<?> origin)`
*   **Description**: Hook the static initializer (`<clinit>`) of a class.
*   **Modifier**: `final`
*   **Return Type**: `XposedInterface.HookBuilder`
*   **Parameters**:
    *   `origin` (Class<?>) - The class whose static initializer to hook.

#### `listRemoteFiles()`
*   **Description**: List all files in the module's shared data directory.
*   **Modifier**: `final`
*   **Return Type**: `String[]`

#### `log(int priority, String tag, String msg)`
*   **Description**: Writes a message to the Xposed log.
*   **Modifier**: `final`
*   **Return Type**: `void`
*   **Parameters**:
    *   `priority` (int) - The priority level of the log message.
    *   `tag` (String) - The tag for the log message.
    *   `msg` (String) - The log message content.

#### `log(int priority, String tag, String msg, Throwable tr)`
*   **Description**: Writes a message to the Xposed log, including a throwable.
*   **Modifier**: `final`
*   **Return Type**: `void`
*   **Parameters**:
    *   `priority` (int) - The priority level of the log message.
    *   `tag` (String) - The tag for the log message.
    *   `msg` (String) - The log message content.
    *   `tr` (Throwable) - The throwable to log.

#### `openRemoteFile(String name)`
*   **Description**: Open a file in the module's shared data directory.
*   **Modifier**: `final`
*   **Return Type**: `ParcelFileDescriptor`
*   **Parameters**:
    *   `name` (String) - The name of the file to open.
```

--------------------------------

### LibXposed API Packages

Source: https://libxposed.github.io/api/index.html

Overview of the primary packages provided by the LibXposed library.

```APIDOC
## Package Overview

### io.github.libxposed.api
- **Description**: Modern Xposed Module API.

### io.github.libxposed.api.error
- **Description**: Error handling components for the LibXposed API.
```

--------------------------------

### XposedInterfaceWrapper API

Source: https://libxposed.github.io/api/index-all.html

Wrapper class for the XposedInterface.

```APIDOC
## attachFramework(XposedInterface)

### Description
Attaches the framework interface to the module.

### Method
`method`

### Endpoint
`io.github.libxposed.api.XposedInterfaceWrapper`
```

--------------------------------

### Xposed Interface Wrapper

Source: https://libxposed.github.io/api/allclasses-index.html

Wrapper class for XposedInterface to abstract framework details.

```APIDOC
## XposedInterfaceWrapper

### Description
Wrapper of `XposedInterface` used by modules to shield framework implementation details.

### Class
`XposedInterfaceWrapper`
```

--------------------------------

### LibXposed Core Interfaces

Source: https://libxposed.github.io/api/overview-tree.html

Overview of the primary interfaces used for hooking and module lifecycle management in LibXposed.

```APIDOC
## Core Interfaces

### Description
Defines the primary interfaces for interacting with the Xposed framework, including hook builders, invokers, and module lifecycle parameters.

### Key Interfaces
- **XposedInterface**: The base interface for framework interaction.
- **HookBuilder**: Used to construct and register hooks.
- **Hooker**: Defines the logic for intercepted methods.
- **Invoker**: Handles the invocation of original methods or constructors.

### Lifecycle Parameters
- **ModuleLoadedParam**: Triggered when the module is loaded.
- **PackageLoadedParam**: Triggered when a target package is loaded.
- **SystemServerStartingParam**: Triggered during system server initialization.
```

--------------------------------

### XposedInterface API

Source: https://libxposed.github.io/api/index-all.html

Core interface for interacting with the Xposed framework.

```APIDOC
## API_101

### Description
Static variable indicating the first API version. Modules targeting API 101 or higher will experience behavior changes where modules cannot be injected into zygote and are only loaded within the process of the scope.

### Method
`static variable`

### Endpoint
`io.github.libxposed.api.XposedInterface`

## deoptimize(Executable)

### Description
Deoptimizes a method or constructor. This is useful in cases where a hooked callee is not called due to inlining.

### Method
`interface` or `class`

### Endpoint
`io.github.libxposed.api.XposedInterface` or `io.github.libxposed.api.XposedInterfaceWrapper`
```

--------------------------------

### XposedModuleInterface.PackageReadyParam API

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModuleInterface.PackageReadyParam.html

Details for the PackageReadyParam interface, which wraps information about a package's classloader state.

```APIDOC
## Interface: XposedModuleInterface.PackageReadyParam

### Description
Wraps information about the package whose classloader is ready. This information indicates the state at the time of loading and will not be updated.

### Methods

#### getClassLoader()
- **Returns**: ClassLoader
- **Description**: Gets the classloader of the current package. It may be different from `getDefaultClassLoader()` if the package has a custom `AppComponentFactory`.

#### getAppComponentFactory()
- **Returns**: AppComponentFactory
- **Description**: Gets the `AppComponentFactory` of the current package. Requires API level 28 or higher.
```

--------------------------------

### Hooking Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Methods for hooking methods, constructors, and class initializers.

```APIDOC
## POST /hook

### Description
Hooks a method, constructor, or class initializer.

### Methods
- hook(Executable origin): HookBuilder - Hooks a method or constructor.
- hookClassInitializer(Class origin): HookBuilder - Hooks the static initializer of a class.

### Parameters
- origin (Executable/Class) - Required - The target to be hooked.
```

--------------------------------

### XposedModuleInterface Lifecycle Methods

Source: https://libxposed.github.io/api/index-all.html

Methods used to handle module lifecycle events within the target process.

```APIDOC
## onModuleLoaded(ModuleLoadedParam)

### Description
Gets notified when the module is loaded into the target process. This callback is guaranteed to be called exactly once for a process.

## onPackageLoaded(PackageLoadedParam)

### Description
Gets notified when a package is loaded into the process.

## onPackageReady(PackageReadyParam)

### Description
Gets notified when AppComponentFactory has instantiated the classloader and is ready to create Application.

## onSystemServerStarting(SystemServerStartingParam)

### Description
Gets notified when system server is ready to start critical services.
```

--------------------------------

### XposedModuleInterface Lifecycle Methods

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModuleInterface.html

Interface methods for handling module and package lifecycle events within the Xposed framework.

```APIDOC
## onModuleLoaded

### Description
Gets notified when the module is loaded into the target process. This callback is guaranteed to be called exactly once for a process.

### Parameters
- **param** (XposedModuleInterface.ModuleLoadedParam) - Required - Information about the process in which the module is loaded

## onPackageLoaded

### Description
Gets notified when a package is loaded into the process. This occurs when the default classloader is ready but before the instantiation of AppComponentFactory.

### Parameters
- **param** (XposedModuleInterface.PackageLoadedParam) - Required - Information about the package being loaded

## onPackageReady

### Description
Gets notified when AppComponentFactory has instantiated the classloader and is ready to create the Application.

### Parameters
- **param** (XposedModuleInterface.PackageReadyParam) - Required - Information about the package being loaded

## onSystemServerStarting

### Description
Gets notified when the system server is ready to start critical services. This callback replaces the first callback phase of onPackageLoaded and onPackageReady in the system server.

### Parameters
- **param** (XposedModuleInterface.SystemServerStartingParam) - Required - Information about system server
```

--------------------------------

### XposedModule Class Overview

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModule.html

The XposedModule class is the primary entry point for Xposed modules. It implements XposedModuleInterface and provides hooks for module lifecycle events.

```APIDOC
## Class: io.github.libxposed.api.XposedModule

### Description
Super class which all Xposed module entry classes should extend. Entry classes are instantiated exactly once for each process. Modules should not perform initialization work before onModuleLoaded is called.

### Constructor
- **XposedModule()** - Initializes the module instance.

### Implemented Interfaces
- XposedInterface
- XposedModuleInterface

### Lifecycle Methods
- **onModuleLoaded(ModuleLoadedParam)** - Called when the module is loaded.
- **onPackageLoaded(PackageLoadedParam)** - Called when a package is loaded.
- **onPackageReady(PackageReadyParam)** - Called when a package is ready.
- **onSystemServerStarting(SystemServerStartingParam)** - Called when the system server starts.
```

--------------------------------

### LibXposed API Packages

Source: https://libxposed.github.io/api/allpackages-index.html

Overview of the primary packages provided by the LibXposed API library.

```APIDOC
## Package Overview

### io.github.libxposed.api
- **Description**: The core package for the Modern Xposed Module API.

### io.github.libxposed.api.error
- **Description**: Contains error handling classes and exceptions for the LibXposed API.
```

--------------------------------

### Error Handling Classes

Source: https://libxposed.github.io/api/allclasses-index.html

Details on exceptions thrown by the Xposed framework.

```APIDOC
## HookFailedError

### Description
Thrown to indicate that a hook failed due to a framework internal error.

### Class
`HookFailedError`

## XposedFrameworkError

### Description
Thrown to indicate that the Xposed framework function is broken.

### Class
`XposedFrameworkError`
```

--------------------------------

### Instantiating XposedFrameworkError

Source: https://libxposed.github.io/api/io/github/libxposed/api/error/XposedFrameworkError.html

Demonstrates how to throw an XposedFrameworkError within a Java application. This class supports initialization with a custom message, a cause, or both.

```java
try {
    throw new XposedFrameworkError("The Xposed framework function is broken.");
} catch (XposedFrameworkError e) {
    e.printStackTrace();
}

// Or with a cause
try {
    throw new XposedFrameworkError("Framework failure", originalException);
} catch (XposedFrameworkError e) {
    // Handle error
}
```

--------------------------------

### Controlling Execution Flow with XposedInterface.Chain (Java)

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Chain.html

Illustrates how to control the execution flow within an Xposed hook using the XposedInterface.Chain. Methods like `proceed()` and `proceedWith()` allow the interceptor to pass control to the next element in the chain, optionally modifying arguments or the `this` object.

```Java
Object proceed() throws Throwable
Object proceed(Object[] args) throws Throwable
Object proceedWith(Object thisObject) throws Throwable
Object proceedWith(Object thisObject, Object[] args) throws Throwable
```

--------------------------------

### XposedModule Class

Source: https://libxposed.github.io/api/index-all.html

The base class for all Xposed module entry points. Modules must extend this class to be instantiated by the framework.

```APIDOC
## XposedModule

### Description
Super class which all Xposed module entry classes should extend. Entry classes will be instantiated exactly once for each process.

### Constructor
- **XposedModule()** - Initializes the module entry class.
```

--------------------------------

### XposedModuleInterface.ModuleLoadedParam API

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModuleInterface.ModuleLoadedParam.html

Information about the process in which the module is loaded. This information only indicates the state at the time of loading and will not be updated.

```APIDOC
## XposedModuleInterface.ModuleLoadedParam

### Description
Wraps information about the process in which the module is loaded. This information only indicates the state at the time of loading and will not be updated.

### Methods

#### getProcessName

```java
@NonNull String getProcessName()
```

Gets the process name.

**Returns:**
- `String` - The process name.

#### isSystemServer

```java
boolean isSystemServer()
```

Returns whether the current process is system server.

**Returns:**
- `boolean` - `true` if the current process is system server, `false` otherwise.
```

--------------------------------

### Basic Hooking with Interceptor Chain

Source: https://libxposed.github.io/api/io/github/libxposed/api/package-summary.html

Implement a Hooker to intercept method calls. Use the builder pattern to set priority and exception mode, then define pre- and post-processing logic within the interceptor. This is suitable for advanced hooking scenarios requiring fine-grained control.

```java
HookHandle handle = hook(method)
    .setPriority(PRIORITY_DEFAULT)
    .setExceptionMode(ExceptionMode.PROTECTIVE)
    .intercept(chain -> {
        // pre-processing
        Object result = chain.proceed();
        // post-processing
        return result;
    });

```

--------------------------------

### LibXposed Core Interfaces

Source: https://libxposed.github.io/api/io/github/libxposed/api/package-summary.html

Overview of the primary interfaces and classes used for hooking and module management within the LibXposed framework.

```APIDOC
## LibXposed Core Components

### Description
Core classes and interfaces for interacting with application processes and managing hooks.

### Key Classes
- **XposedInterface**: Primary interface for modules to operate on application processes.
- **XposedModule**: Base class for module entry points, instantiated once per process.
- **XposedInterface.HookBuilder**: Builder pattern for configuring method or constructor hooks.
- **XposedInterface.Hooker**: The hooker implementation for methods or constructors.

### Error Handling
- **XposedFrameworkError**: Base class for framework-level errors.
- **HookFailedError**: Indicates a fatal hook failure that should be reported to framework maintainers.
```

--------------------------------

### getApiVersion

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Retrieves the runtime Xposed API version.

```APIDOC
## getApiVersion

### Description
Gets the runtime Xposed API version. Framework implementations must not override this method.

### Response
#### Success Response (200)
- **version** (int) - The API version
```

--------------------------------

### Configuring Invoker Type

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.Invoker.html

Illustrates how to set the invocation type for an invoker, which dictates the specific hook chain behavior.

```java
invoker.setType(XposedInterface.Invoker.Type.SOME_TYPE);

```

--------------------------------

### XposedModuleInterface.PackageLoadedParam

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModuleInterface.PackageLoadedParam.html

Provides access to information about a package when it is loaded. This data reflects the state at the time of loading and is not updated dynamically.

```APIDOC
## XposedModuleInterface.PackageLoadedParam

### Description
Wraps information about the package being loaded. This information only indicates the state at the time of loading and will not be updated.

### Methods

#### getPackageName

Gets the package name of the current package.

- **Returns**: `String` - The package name.

#### getApplicationInfo

Gets the `ApplicationInfo` of the current package.

- **Returns**: `ApplicationInfo` - The ApplicationInfo.

#### isFirstPackage

Returns whether this is the first and main package loaded in the process.

- **Returns**: `boolean` - `true` if this is the first package.

#### getDefaultClassLoader

Gets the default classloader of the current package. This is the classloader that loads the package's code, resources and custom `AppComponentFactory`.

- **Requires API Level**: 29
- **Returns**: `ClassLoader` - The default classloader.
```

--------------------------------

### Method: getClassLoader

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedModuleInterface.SystemServerStartingParam.html

Retrieves the ClassLoader associated with the system server at the time of loading.

```APIDOC
## GET getClassLoader

### Description
Gets the class loader of the system server. This information reflects the state at the time of loading and is not updated subsequently.

### Method
GET

### Response
#### Success Response (200)
- **ClassLoader** (Object) - The class loader of the system server.
```

--------------------------------

### hook

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Hooks a method or constructor.

```APIDOC
## hook

### Description
Hook a method / constructor.

### Parameters
#### Request Body
- **origin** (Executable) - Required - The executable to be hooked

### Response
#### Success Response (200)
- **builder** (XposedInterface.HookBuilder) - The builder for the hook
```

--------------------------------

### Hooking and Invocation Methods

Source: https://libxposed.github.io/api/index-all.html

Methods related to method hooking, constructor invocation, and chain management.

```APIDOC
## GET getExecutable()

### Description
Gets the method or constructor being hooked (available in Chain and HookHandle).

## GET getInvoker(Constructor<T>)

### Description
Get a constructor invoker for the given constructor.

## GET getInvoker(Method)

### Description
Get a method invoker for the given method.

## GET getArg(int)

### Description
Gets the argument at the given index (Chain).

## GET getArgs()

### Description
Gets the arguments (Chain).

## GET getThisObject()

### Description
Gets the 'this' pointer for the call, or 'null' for static methods (Chain).
```

--------------------------------

### attachFramework

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Attaches the framework interface to the module.

```APIDOC
## attachFramework

### Description
Attaches the framework interface to the module. Modules should never call this method.

### Parameters
#### Request Body
- **base** (XposedInterface) - Required - The framework interface
```

--------------------------------

### LibXposed Error Handling

Source: https://libxposed.github.io/api/overview-tree.html

Documentation for the error hierarchy used within the LibXposed framework.

```APIDOC
## Error Handling

### Description
LibXposed uses a specific hierarchy for framework-related errors to ensure robust module development.

### Error Classes
- **XposedFrameworkError**: Base class for all framework-related errors.
- **HookFailedError**: Thrown when a hook registration or execution fails.

### Usage
Catch these specific errors to handle failures in hook injection or framework communication gracefully.
```

--------------------------------

### listRemoteFiles

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

List all files in the module's shared data directory.

```APIDOC
## listRemoteFiles

### Description
List all files in the module's shared data directory.

### Response
- **String[]** (Array) - The file list
```

--------------------------------

### Manage Hook Lifecycle with HookHandle

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.HookHandle.html

Demonstrates how to retrieve the hooked executable and safely remove a hook using the HookHandle interface. The unhook method is idempotent, ensuring safe repeated calls.

```java
public void manageHook(XposedInterface.HookHandle handle) {
	// Retrieve the hooked method or constructor
	java.lang.reflect.Executable target = handle.getExecutable();
	System.out.println("Hooked: " + target.getName());

	// Remove the hook
	handle.unhook();
}
```

--------------------------------

### XposedInterface.HookBuilder API

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.HookBuilder.html

Methods for configuring and finalizing a hook registration using the HookBuilder interface.

```APIDOC
## HookBuilder Configuration

### Description
The HookBuilder interface allows developers to set execution priority and exception handling modes before finalizing a hook with an interceptor.

### Methods
- **setPriority(int priority)**: Sets the execution order. Higher values execute first.
- **setExceptionMode(ExceptionMode mode)**: Configures how exceptions are handled during the hook execution.
- **intercept(Hooker hooker)**: Finalizes the builder and returns a HookHandle.

### Parameters
#### setPriority
- **priority** (int) - Required - The priority level of the hook.

#### setExceptionMode
- **mode** (XposedInterface.ExceptionMode) - Required - The desired exception handling strategy.

#### intercept
- **hooker** (XposedInterface.Hooker) - Required - The implementation logic to execute when the hooked method is called.

### Usage Example
```java
builder.setPriority(10)
       .setExceptionMode(XposedInterface.ExceptionMode.DEFAULT)
       .intercept(myHooker);
```

### Response
- **Returns**: XposedInterface.HookHandle (on intercept success)
- **Throws**: IllegalArgumentException if the target is invalid or Hooker is null; HookFailedError if the framework fails to apply the hook.
```

--------------------------------

### openRemoteFile

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterfaceWrapper.html

Open a file in the module's shared data directory.

```APIDOC
## openRemoteFile

### Description
Open a file in the module's shared data directory. The file is opened in read-only mode.

### Parameters
#### Query Parameters
- **name** (String) - Required - File name, must not contain path separators and . or ..

### Response
- **ParcelFileDescriptor** (Object) - The file descriptor
```

--------------------------------

### XposedInterface

Source: https://libxposed.github.io/api/index-all.html

The primary interface for modules to interact with application processes and manage hooks.

```APIDOC
## XposedInterface

### Description
Xposed interface for modules to operate on application processes. It includes sub-interfaces for hook management, invokers, and chain handling.

### Components
- **Chain**: Interceptor chain for a method or constructor.
- **CtorInvoker<T>**: Invoker for a constructor.
- **ExceptionMode**: Enum for exception handling mode.
- **HookBuilder**: Builder for configuring a hook.
- **Hooker**: Hooker for a method or constructor.
- **HookHandle**: Handle for a hook.
- **Invoker<T,U>**: Invoker for a method or constructor.
```

--------------------------------

### XposedInterface.CtorInvoker Interface

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.CtorInvoker.html

Provides methods to invoke constructors and create new instances of a class, with support for constructor chaining and special instantiation scenarios.

```APIDOC
## Interface XposedInterface.CtorInvoker<T>

### Description
Invoker for a constructor. This interface extends `XposedInterface.Invoker` and provides specialized methods for constructor-related operations.

### Type Parameters
* `T` - The type of the constructor.

### Superinterfaces
* `XposedInterface.Invoker<XposedInterface.CtorInvoker<T>, Constructor<T>>`

### Methods
#### `newInstance(Object... args)`
Creates a new instance through the hook chain determined by the invoker's type.

* **Parameters**
  * `args` (Object...) - The arguments used for the construction.

* **Returns**
  The instance created and initialized by the constructor.

* **Throws**
  * `InvocationTargetException`
  * `IllegalArgumentException`
  * `IllegalAccessException`
  * `InstantiationException`

* **See Also**
  * `Constructor.newInstance(Object...)`

#### `newInstanceSpecial(Class<U> subClass, Object... args)`
Creates a new instance of the given subclass, but initializes it with a parent constructor. This could leave the object in an invalid state, where the subclass constructor is not called and the fields of the subclass are not initialized. This method is useful when you need to initialize some fields in the subclass by yourself.

* **Type Parameters**
  * `U` - The type of the subclass.

* **Parameters**
  * `subClass` (Class<U>) - The subclass to create a new instance.
  * `args` (Object...) - The arguments used for the construction.

* **Returns**
  The instance of subclass initialized by the constructor.

* **Throws**
  * `InvocationTargetException`
  * `IllegalArgumentException`
  * `IllegalAccessException`
  * `InstantiationException`

* **See Also**
  * `Constructor.newInstance(Object...)`

### Inherited Methods
Methods inherited from interface `io.github.libxposed.api.XposedInterface.Invoker`:
* `invoke`
* `invokeSpecial`
* `setType`
```

--------------------------------

### XposedInterface.Invoker.Type.Origin

Source: https://libxposed.github.io/api/index-all.html

Represents the origin type within the Invoker.

```APIDOC
## equals(Object)

### Description
Indicates whether some other object is "equal to" this one.

### Method
`method`

### Endpoint
`io.github.libxposed.api.XposedInterface.Invoker.Type.Origin`
```

--------------------------------

### Nested Classes

Source: https://libxposed.github.io/api/io/github/libxposed/api/XposedInterface.html

Details of the nested static interfaces and enums within XposedInterface.

```APIDOC
## Nested Classes

### `XposedInterface.Chain`
**Type:** `static interface`
**Description:** Interceptor chain for a method or constructor.

### `XposedInterface.CtorInvoker<T>`
**Type:** `static interface`
**Description:** Invoker for a constructor.

### `XposedInterface.ExceptionMode`
**Type:** `static enum`
**Description:** Exception handling mode for hookers.

### `XposedInterface.HookBuilder`
**Type:** `static interface`
**Description:** Builder for configuring a hook.

### `XposedInterface.Hooker`
**Type:** `static interface`
**Description:** Hooker for a method or constructor.

### `XposedInterface.HookHandle`
**Type:** `static interface`
**Description:** Handle for a hook.

### `XposedInterface.Invoker<T, U>`
**Type:** `static interface`
**Description:** Invoker for a method or constructor.
```
Tokens:
Raw