Class ClassFactory

constructor

• new ClassFactory(): ClassFactory

  Returns ClassFactory

cacheDir

Readonlyloader

tempFileNaming

array

• array(type: string, elements: any[]): any[]

  Creates a Java array with elements of the specified type, from a JavaScript array elements. The resulting Java array behaves like a JS array, but can be passed by reference to Java APIs in order to allow them to modify its contents.

  Parameters

  • type: string

    Type name of elements.

  • elements: any[]

    Array of JavaScript values to use for constructing the Java array.

  Returns any[]

cast

• cast<From extends Members<From> = {}, To extends Members<To> = {}>(
      handle: NativePointerValue | Wrapper<From>,
      klass: Wrapper<To>,
  ): Wrapper<To>

  Creates a JavaScript wrapper given the existing instance at handle of given class klass as returned from Java.use().

  Type Parameters

  • From extends Members<From> = {}
  • To extends Members<To> = {}

  Parameters

  • handle: NativePointerValue | Wrapper<From>

    An existing wrapper or a JNI handle.

  • klass: Wrapper<To>

    Class wrapper for type to cast to.

  Returns Wrapper<To>

choose

• choose<T extends Members<T> = {}>(
      className: string,
      callbacks: ChooseCallbacks<T>,
  ): void

  Enumerates live instances of the className class by scanning the Java VM's heap.

  Type Parameters

  • T extends Members<T> = {}

  Parameters

  • className: string

    Name of class to enumerate instances of.

  • callbacks: ChooseCallbacks<T>

    Object with callbacks.

  Returns void

Staticget

• get(classLoader: Wrapper<{}>): ClassFactory

  Gets the class factory instance for a given class loader, or the default factory when passing null.

  The default class factory used behind the scenes only interacts with the application's main class loader. Other class loaders can be discovered through APIs such as Java.enumerateMethods() and Java.enumerateClassLoaders(), and subsequently interacted with through this API.

  Parameters

  • classLoader: Wrapper<{}>

  Returns ClassFactory

openClassFile

• openClassFile(filePath: string): DexFile

  Opens the .dex file at filePath.

  Parameters

  • filePath: string

    Path to .dex to open.

  Returns DexFile

registerClass

• registerClass(spec: default.ClassSpec): Wrapper

  Creates a new Java class.

  Parameters

  • spec: default.ClassSpec

    Object describing the class to be created.

  Returns Wrapper

retain

• retain<T extends Members<T> = {}>(obj: Wrapper<T>): Wrapper<T>

  Duplicates a JavaScript wrapper for later use outside replacement method.

  Type Parameters

  • T extends Members<T> = {}

  Parameters

  • obj: Wrapper<T>

    An existing wrapper retrieved from this in replacement method.

  Returns Wrapper<T>

use

• use<T extends Members<T> = {}>(className: string): Wrapper<T>

  Dynamically generates a JavaScript wrapper for className that you can instantiate objects from by calling $new() on to invoke a constructor. Call $dispose() on an instance to clean it up explicitly, or wait for the JavaScript object to get garbage-collected, or script to get unloaded. Static and non-static methods are available, and you can even replace method implementations.

  Type Parameters

  • T extends Members<T> = {}

  Parameters

  • className: string

    Canonical class name to get a wrapper for.

  Returns Wrapper<T>