:github_url: hide .. _class_JavaScriptBridge: JavaScriptBridge ================ **Hereda:** :ref:`Object` Singleton que conecta el motor con el contexto de JavaScript del navegador en la exportación Web. .. rst-class:: classref-introduction-group Descripción ---------------------- The JavaScriptBridge singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. \ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../engine_details/development/compiling/compiling_for_web>` in the documentation for more information. .. rst-class:: classref-introduction-group Tutoriales -------------------- - :doc:`The JavaScriptBridge singleton <../tutorials/platform/web/javascript_bridge>` .. rst-class:: classref-reftable-group Métodos -------------- .. table:: :widths: auto +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JavaScriptObject` | :ref:`create_callback`\ (\ callable\: :ref:`Callable`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`create_object`\ (\ object\: :ref:`String`, ...\ ) |vararg| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`download_buffer`\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`eval`\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_fs_sync`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JavaScriptObject` | :ref:`get_interface`\ (\ interface\: :ref:`String`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_js_buffer`\ (\ javascript_object\: :ref:`JavaScriptObject`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`js_buffer_to_packed_byte_array`\ (\ javascript_buffer\: :ref:`JavaScriptObject`\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`pwa_needs_update`\ (\ ) |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`pwa_update`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Señales -------------- .. _class_JavaScriptBridge_signal_pwa_update_available: .. rst-class:: classref-signal **pwa_update_available**\ (\ ) :ref:`🔗` Emitida cuando se ha detectado una actualización para esta aplicación web progresiva pero está esperando a ser activada porque una versión anterior está activa. Véase :ref:`pwa_update()` para forzar que la actualización se realice inmediatamente. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descripciones de Métodos ------------------------------------------------ .. _class_JavaScriptBridge_method_create_callback: .. rst-class:: classref-method :ref:`JavaScriptObject` **create_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` Crea una referencia a un :ref:`Callable` que puede ser utilizado como un callback por JavaScript. La referencia debe mantenerse hasta que el callback se produzca, o no será llamado en absoluto. Véase :ref:`JavaScriptObject` para su uso. \ **Nota:** La función de callback debe tomar exactamente un argumento :ref:`Array`, que va a ser el `objeto arguments `__ de JavaScript convertido en un array. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_create_object: .. rst-class:: classref-method :ref:`Variant` **create_object**\ (\ object\: :ref:`String`, ...\ ) |vararg| :ref:`🔗` Crea un nuevo objeto de JavaScript usando el constructor ``new``. El ``object`` debe ser una propiedad válida de la ``window`` de JavaScript. Véase :ref:`JavaScriptObject` para su uso. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_download_buffer: .. rst-class:: classref-method |void| **download_buffer**\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) :ref:`🔗` Prompts the user to download a file containing the specified ``buffer``. The file will have the given ``name`` and ``mime`` type. \ **Note:** The browser may override the `MIME type `__ provided based on the file ``name``'s extension. \ **Note:** Browsers might block the download if :ref:`download_buffer()` is not being called from a user interaction (e.g. button click). \ **Note:** Browsers might ask the user for permission or block the download if multiple download requests are made in a quick succession. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_eval: .. rst-class:: classref-method :ref:`Variant` **eval**\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) :ref:`🔗` Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``. If ``use_global_execution_context`` is ``true``, the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_force_fs_sync: .. rst-class:: classref-method |void| **force_fs_sync**\ (\ ) :ref:`🔗` Fuerza la sincronización del sistema de archivos persistente (cuando está habilitado). \ **Nota: ** Esto sólo es útil para módulos o extensiones que no pueden usar :ref:`FileAccess` para escribir archivos. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_get_interface: .. rst-class:: classref-method :ref:`JavaScriptObject` **get_interface**\ (\ interface\: :ref:`String`\ ) :ref:`🔗` Devuelve una interfaz a un objeto de JavaScript que puede ser utilizado por scripts. La ``interface`` debe ser una propiedad válida de la ventana de JavaScript ````. El callback debe aceptar un solo argumento :ref:`Array`, el cual contiene los ``arguments`` de JavaScript. Véase :ref:`JavaScriptObject` para su uso. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_is_js_buffer: .. rst-class:: classref-method :ref:`bool` **is_js_buffer**\ (\ javascript_object\: :ref:`JavaScriptObject`\ ) :ref:`🔗` Returns ``true`` if the given ``javascript_object`` is of type `[code]ArrayBuffer[/code] `__, `[code]DataView[/code] `__, or one of the many `typed array objects `__. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_js_buffer_to_packed_byte_array: .. rst-class:: classref-method :ref:`PackedByteArray` **js_buffer_to_packed_byte_array**\ (\ javascript_buffer\: :ref:`JavaScriptObject`\ ) :ref:`🔗` Devuelve una copia del contenido de ``javascript_buffer`` como un :ref:`PackedByteArray`. Véase también :ref:`is_js_buffer()`. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_pwa_needs_update: .. rst-class:: classref-method :ref:`bool` **pwa_needs_update**\ (\ ) |const| :ref:`🔗` Devuelve ``true`` si una nueva versión de la aplicación web progresiva está esperando ser activada. \ **Nota:** Solo es relevante cuando se exporta como una Aplicación Web Progresiva. .. rst-class:: classref-item-separator ---- .. _class_JavaScriptBridge_method_pwa_update: .. rst-class:: classref-method :ref:`Error` **pwa_update**\ (\ ) :ref:`🔗` Realiza la actualización en vivo de la aplicación web progresiva. Forzando la instalación de la nueva versión y la recarga de la página. \ **Nota:** Tu aplicación se **recargará en todas las pestañas del navegador**. \ **Nota:** Solo es relevante cuando se exporta como una Aplicación Web Progresiva y :ref:`pwa_needs_update()` devuelve ``true``. .. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)` .. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)` .. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)` .. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)` .. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)` .. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)` .. |void| replace:: :abbr:`void (Sin valor de retorno.)`