jsdoc modulofirebase

moduloFirebase

Módulo Firebase.

Extiende: modulo

Métodos

cargar([opciones])

Carga el SDK de Firebase en la página.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object	Opciones.	Si

Propiedades de opciones

Propiedad	Tipo	Descripción	Opcional	Predeterminado
librerias	string[]	Nombres de las librerías a incluir (ver https://firebase.google.com/docs/web/setup#available-libraries). Por defecto, ["messaging"].	Si
config	Object	Configuración de Firebase (objeto con las propiedades apiKey, authDomain, projectId, storageBucket, messagingSenderId, appId tal como es provisto en la consola de Firebase). Opcional; si se omite, se intentará obtener desde el servidor. Si es false para omitir la inicialización de Firebase.	Si
retorno	function	Función de retorno.	Si

Devuelve: moduloFirebase

cargarLibrerias(librerias,retorno)

Carga las librerías de Firebase.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
librerias	string[]	Nombres de las librerías. Por ejemplo messaging, analytics, etc.
retorno	function	Función de retorno.

Devuelve: moduloFirebase

configurar([config,retorno])

Configura el SDK de Firebase.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
config	Object	Configuración de Firebase (objeto con las propiedades apiKey, authDomain, projectId, storageBucket, messagingSenderId, appId tal como es provisto en la consola de Firebase). Opcional; si se omite, se intentará obtener desde el servidor.	Si
retorno	function	Función de retorno.	Si

Devuelve: moduloFirebase

notificacionesCordova(opciones)

Inicializa y autoriza notificaciones Push a través de FCM (Firebase Cloud Messaging) en aplicaciones Cordova.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object	Opciones.

Propiedades de opciones

Propiedad	Tipo	Descripción	Opcional	Predeterminado
retorno	function	Función de retorno. Recibirá como único parámetro la clave o token.	Si
error	function	Función de retorno en caso de error o cancelación de la solicitud. Recibirá como único parámetro el error (como cadena), false si fue cancelada o denegada la autorización o null si no fue posible iniciar el servicio.	Si

Devuelve: moduloFirebase

notificacionesWeb(opciones)

Inicializa y autoriza notificaciones Push a través de FCM (Firebase Cloud Messaging) en el navegador web de escritorio o móvil.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
opciones	Object	Opciones.

Propiedades de opciones

Propiedad	Tipo	Descripción	Opcional	Predeterminado
clave	string	Clave pública. Si se omite, se utilizará el parámetro vapid de la configuración inicial del módulo.	Si
retorno	function	Función de retorno. Recibirá como único parámetro la clave o token.	Si
error	function	Función de retorno en caso de error o cancelación de la solicitud.	Si

Devuelve: moduloFirebase