WeiguangTWK
/
api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More docs

This commit is contained in:
Nullptr 2023-07-22 12:50:58 +08:00
parent 4be04fc3ce
commit b6926a5fba
No known key found for this signature in database
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
api/src/main/java/io/github/libxposed/api/XposedInterface.java
View File

@ -79,9 +79,9 @@ public interface XposedInterface {
* The before invocation method should have the following signature:<br/> * The before invocation method should have the following signature:<br/>
* params: {@code member} - The {@link Member} object representing the method or constructor being hooked<br/> * params: {@code member} - The {@link Member} object representing the method or constructor being hooked<br/>
* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
* {@code thisObject} - The {@code this} pointer, or null if the method is static<br/> * {@code thisObject} - The {@code this} pointer, or null if the method is static<br/>
* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
* {@code args} - The arguments used for the method call<br/> * {@code args} - The arguments used for the method call<br/>
* returns: An {@link Hooker} object, used to save contextual information for current invocation routine * returns: An {@link Hooker} object, used to save contextual information for current invocation routine
* </p> * </p>
* *
@ -89,7 +89,7 @@ public interface XposedInterface {
* The after invocation method should have the following signature:<br/> * The after invocation method should have the following signature:<br/>
* params: {@code extras} - The {@link Hooker} object returned by the before invocation method<br/> * params: {@code extras} - The {@link Hooker} object returned by the before invocation method<br/>
* &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
* {@code result} - The result of the invocation * {@code result} - The result of the invocation
* </p> * </p>
* *
* <p>Example usage:</p> * <p>Example usage:</p>
@ -164,52 +164,56 @@ public interface XposedInterface {
int getFrameworkPrivilege(); int getFrameworkPrivilege();
/** /**
* Hook method unhooker. * Hook a method with default priority.
* *
* @param origin the origin * @param origin The method to be hooked
* @param hooker the hooker * @param hooker The hooker class
* @return the method unhooker * @return Unhooker for canceling the hook
* @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke} * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke},
* or hooker is invalid
* @throws HookFailedError if hook fails due to framework internal error * @throws HookFailedError if hook fails due to framework internal error
*/ */
@NonNull @NonNull
MethodUnhooker<Method> hook(@NonNull Method origin, @NonNull Class<? extends Hooker> hooker); MethodUnhooker<Method> hook(@NonNull Method origin, @NonNull Class<? extends Hooker> hooker);
/** /**
* Hook method unhooker. * Hook a method with specified priority.
* *
* @param origin the origin * @param origin The method to be hooked
* @param priority the priority * @param priority The hook priority
* @param hooker the hooker * @param hooker The hooker class
* @return the method unhooker * @return Unhooker for canceling the hook
* @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke} * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke},
* or hooker is invalid
* @throws HookFailedError if hook fails due to framework internal error * @throws HookFailedError if hook fails due to framework internal error
*/ */
@NonNull @NonNull
MethodUnhooker<Method> hook(@NonNull Method origin, int priority, @NonNull Class<? extends Hooker> hooker); MethodUnhooker<Method> hook(@NonNull Method origin, int priority, @NonNull Class<? extends Hooker> hooker);
/** /**
* Hook method unhooker. * Hook a constructor with default priority.
* *
* @param <T> the type parameter * @param <T> The type of the constructor
* @param origin the origin * @param origin The constructor to be hooked
* @param hooker the hooker * @param hooker The hooker class
* @return the method unhooker * @return Unhooker for canceling the hook
* @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke} * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke},
* or hooker is invalid
* @throws HookFailedError if hook fails due to framework internal error * @throws HookFailedError if hook fails due to framework internal error
*/ */
@NonNull @NonNull
<T> MethodUnhooker<Constructor<T>> hook(@NonNull Constructor<T> origin, @NonNull Class<? extends Hooker> hooker); <T> MethodUnhooker<Constructor<T>> hook(@NonNull Constructor<T> origin, @NonNull Class<? extends Hooker> hooker);
/** /**
* Hook method unhooker. * Hook a constructor with specified priority.
* *
* @param <T> the type parameter * @param <T> The type of the constructor
* @param origin the origin * @param origin The constructor to be hooked
* @param priority the priority * @param priority The hook priority
* @param hooker the hooker * @param hooker The hooker class
* @return the method unhooker * @return Unhooker for canceling the hook
* @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke} * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke},
* or hooker is invalid
* @throws HookFailedError if hook fails due to framework internal error * @throws HookFailedError if hook fails due to framework internal error
*/ */
@NonNull @NonNull