Configuración

Para tener un control más detallado sobre el sistema de actualizaciones, puede configurarlo con estos ajustes:

Consejo

Cualquier cambio en estos ajustes en el archivo capacitor.config requiere sincronizar la plataforma y publicar en la tienda para que las aplicaciones de producción las reciban.

allowModifyUrl

Permite al plugin modificar la URL de actualización, la URL de estadísticas y la URL de canal dinámicamente desde el lado del JavaScript.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Configure el id de la aplicación para la aplicación en la configuración.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización ‘fallida’.

Disponible en Android, iOS y Electron.

Predeterminado: 10000 (10 segundos)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Configure si el plugin debe eliminar automáticamente los bundles fallidos.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Configure si el plugin debe eliminar automáticamente los bundles previos después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Automáticamente maneja la ocultación de la pantalla de bienvenida cuando se utiliza directUpdate. Cuando está habilitado, el complemento ocultará automáticamente la pantalla de bienvenida después de aplicar actualizaciones o cuando no se necesitan actualizaciones. Esta eliminación elimina la necesidad de escuchar manualmente eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando directUpdate está configurado en “atInstall”, “always” o true. Requiere que el complemento @capacitor/splash-screen esté instalado y configurado con launchAutoHide: false. Requiere que autoUpdate y directUpdate estén habilitados.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

autoUpdate

Configure si el complemento debe utilizar la actualización automática a través de un servidor de actualizaciones.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

channelUrl

Configure la URL / punto de conexión para las operaciones de canal.

Disponible en Android, iOS y Electron.

Predeterminado: https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

Establezca el canal predeterminado para la aplicación en la configuración. La casilla está en mayúsculas. Esta configuración superará al canal predeterminado establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Configura cuándo el plugin debe realizar actualizaciones directas. Solo para modo de actualización automática. Funciona bien para aplicaciones menores a 10MB y con subidas realizadas utilizando la bandera —delta. Archivos zip o aplicaciones mayores a 10MB serán relativamente lentas para los usuarios para actualizar.

Opciones:

• false: Nunca realizar actualizaciones directas (utilizar comportamiento por defecto: descargar al inicio, establecer cuando se ponga en segundo plano)
• 'atInstall': Realizar actualización directa solo cuando la aplicación esté instalada, actualizada desde la tienda, en caso contrario actuar como directUpdate = false
• 'onLaunch': Realizar actualización directa solo en los casos anteriores (aplicación instalada, actualizada desde la tienda o después de que la aplicación se haya detenido), en caso contrario actuar como directUpdate = false
• 'always': Realizar actualización directa en todos los casos anteriores (aplicación instalada, actualizada desde la tienda, después de que la aplicación se haya detenido o se haya reanudado), nunca actuar como directUpdate = false
• true: (obsoleto) Igual que “siempre” para compatibilidad hacia atrás

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall"
    }
  }
}

disableJSLogging

Deshabilitar el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se hará el registro nativo.

Disponible en Android, iOS y Electron.

Valor predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Configurar el plugin para mantener la ruta de URL después de un recarga.

Advertencia

Cuando se desencadena una recarga, ‘window.history’ se borrará.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Configure el período de retraso para la verificación de actualizaciones periódicas. La unidad es en segundos. No puede ser menor a 600 segundos (10 minutos).

Disponible en Android, iOS y Electron.

Predeterminado: 600 (10 minutos)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Configure la clave pública para la cifrado de actualizaciones en vivo de fin a fin, versión 2.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

resetWhenUpdate

Eliminar automáticamente los paquetes descargados previos cuando se instale una versión más nueva del paquete nativo en el dispositivo.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar a API como timeout.

Disponible en Android, iOS y Electron.

Predeterminado: 20 (20 segundos)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Habilitar gesto de sacudida para mostrar el menú de actualización para fines de depuración/pruebas.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Configure la URL / punto de conexión a la que se envían estadísticas de actualización.

Disponible en Android, iOS y Electron. Establezca a "" para deshabilitar el informe de estadísticas.

Predeterminado: https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

Configure la URL / punto de conexión a la que se envían actualizaciones.

Disponible en Android, iOS y Electron.

Predeterminado: https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Configuración de desarrollo

localApi

Configure el CLI para utilizar una api local para pruebas.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Configure el CLI para utilizar un archivo local api para pruebas.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Configure CLI para utilizar un servidor local de prueba.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Configure CLI para utilizar un servidor local de prueba o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Consejo

Hay ajustes adicionales disponibles en la Capgo aplicación web que se pueden configurar por canal sin requerir una actualización de la aplicación nativa.