Funzioni e impostazioni

Configurazione del Plugin di Aggiornamento

Vedi il Github Leggi il Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Descrizione	Impostazioni predefinite	Dal
appReadyTimeout	number	Configura il numero di millisecondi che il plugin nativo deve attendere prima di considerare un aggiornamento come ‘fallito’. Disponibile su Android, iOS e Electron.	10000 // (10 seconds)
responseTimeout	number	Configura il numero di millisecondi che il plugin nativo deve attendere prima di considerare il timeout API. Disponibile su Android, iOS e Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura se il plugin deve utilizzare l'eliminazione automatica dei bundle falliti. Disponibile su Android, iOS e Electron.	true
autoDeletePrevious	boolean	Configura se il plugin deve utilizzare l'eliminazione automatica dei bundle precedenti dopo un aggiornamento riuscito. Disponibile su Android, iOS e Electron.	true
autoUpdate	boolean	Configura se il plugin deve utilizzare l'aggiornamento automatico tramite un server di aggiornamento. Disponibile su Android, iOS e Electron.	true
resetWhenUpdate	boolean	Elimina automaticamente i bundle precedenti scaricati quando viene installato un bundle di app nativa più recente sul dispositivo. Disponibile su Android, iOS e Electron.	true
updateUrl	string	Configura l'URL / endpoint a cui vengono inviate le richieste di aggiornamento. Disponibile su Android, iOS e Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configura l'URL / endpoint per le operazioni di canale. Disponibile su Android, iOS e Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura l'URL / endpoint a cui vengono inviate le statistiche di aggiornamento. Disponibile su Android, iOS e Electron. Impostare su "" per disabilitare la registrazione delle statistiche.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per l'encryption dell'aggiornamento live a fine a fine, Versione 2. Disponibile su Android, iOS e Electron.	undefined	6.2.0
version	string	Configura la versione corrente dell'app. Questa verrà utilizzata per la prima richiesta di aggiornamento. Se non impostato, il plugin otterrà la versione dal nativo code. Disponibile su Android, iOS e Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configura quando il plugin dovrebbe installare gli aggiornamenti direttamente. Solo per il modo di aggiornamento automatico. Funziona bene per le app inferiori ai 10MB e con upload effettuati utilizzando la flag --delta. I zip o le app superiori ai 10MB saranno relativamente lenti per gli utenti per l'aggiornamento. - false: Mai eseguire aggiornamenti diretti (utilizza il comportamento predefinito: scarica all'avvio, imposta quando in background) - atInstall: Aggiornamento diretto solo quando l'app è installata, aggiornata dalla store, altrimenti agisci come directUpdate = false - onLaunch: Aggiornamento diretto solo quando l'app è installata, aggiornata dalla store o dopo l'app ucciso, altrimenti agisci come directUpdate = false - sempre: Aggiornamento diretto in tutti i casi precedenti (app installata, aggiornata dalla store, dopo l'app ucciso o app ripristinata), mai agisci come directUpdate = false - true: (deprecated) Lo stesso di “sempre” per compatibilità con gli ambienti precedenti	false	5.1.0
autoSplashscreen	boolean	Gestisci automaticamente l'occultamento dello schermo di benvenuto quando si utilizza directUpdate. Se abilitato, il plugin nasconderà automaticamente lo schermo di benvenuto dopo l'applicazione degli aggiornamenti o quando non sono necessari aggiornamenti. Ciò elimina la necessità di ascoltare gli eventi appReady e di chiamare SplashScreen.hide(). Funziona solo quando directUpdate è impostato su “atInstall”, “always” o true. Richiede l'installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide: false. Richiede l'abilitazione di autoUpdate e directUpdate. Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per la verifica degli aggiornamenti periodici. L'unità è in secondi. Disponibile su Android, iOS e Electron. Non può essere inferiore a 600 secondi (10 minuti).	600 // (10 minutes)
localS3	boolean	Configura il CLI per utilizzare un server locale per il testing o un server di aggiornamento auto-hosted.	undefined	4.17.48
localHost	string	Configura il CLI per utilizzare un server locale per il testing o un server di aggiornamento auto-hosted.	undefined	4.17.48
localWebHost	string	Configura il CLI per utilizzare un server locale per il testing o un server di aggiornamento auto-hosted.	undefined	4.17.48
localSupa	string	Configura il CLI per utilizzare un server locale per il testing o un server di aggiornamento auto-hosted.	undefined	4.17.48
localSupaAnon	string	Configura il CLI per utilizzare un server locale per il testing.	undefined	4.17.48
localApi	string	Configura il CLI per utilizzare un server locale api per il testing.	undefined	6.3.3
localApiFiles	string	Configura il CLI per utilizzare un file locale api per il testing.	undefined	6.3.3
allowModifyUrl	boolean	Consenti al plugin di modificare dinamicamente l'updateUrl, statsUrl e channelUrl dal lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito dell'app nella configurazione. Sensitive alla maiuscole. Questa impostazione sovrascriverà il canale predefinito impostato in cloud, ma rispetterà comunque le sovrascritture fatte in cloud.	undefined	5.5.0
appId	string	Configura l'ID dell'applicazione nell'applicazione nella config.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configura il plugin per mantenere la URL del percorso dopo un riavvio. AVVISO: quando viene attivato un riavvio, ‘window.history’ verrà cancellato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione JavaScript del plugin. se true, il plugin non registrerà nella console JavaScript. solo la registrazione nativa sarà effettuata	false	7.3.0
shakeMenu	boolean	Abilita il gesto di scuotimento per visualizzare il menu di aggiornamento per scopi di debugging/test	false	7.5.0

Esempi

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

In capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfacce
• Alias di tipo

Metodi

notificaAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica al Capacitor Updater che l'attuale bundle è in esecuzione (si verificherà un rollback se non viene chiamata questa funzione all'avvio di ogni app) Di default questa funzione dovrebbe essere chiamata nei primi 10 sec dopo l'avvio dell'app, altrimenti si verificherà un rollback. Modifica questo comportamento con {@link appReadyTimeout}

Restituisce: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

Imposta l'URL di aggiornamento per l'app, che verrà utilizzato per verificare gli aggiornamenti.

Param	Tipo	Descrizione
options	UpdateUrl	contiene l'URL da utilizzare per verificare le aggiornamenti.

Dal: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Imposta l'URL delle statistiche per l'app, verrà utilizzato per inviare statistiche. Passando una stringa vuota disabilita la raccolta delle statistiche.

Parametro	Tipo	Descrizione
options	StatsUrl	contiene l'URL da utilizzare per inviare statistiche.

Dal: 5.4.0

---

setChannelUrl(…)

setChannelUrl(options: ChannelUrl) => Promise<void>

Imposta l'URL del canale per l'app, verrà utilizzato per impostare il canale.

Parametro	Tipo	Descrizione
options	ChannelUrl	contiene l'URL da utilizzare per impostare il canale.

Dal: 5.4.0

---

download(…)

download(options: DownloadOptions) => Promise<BundleInfo>

Scarica un nuovo bundle dal URL fornito, dovrebbe essere un file zip, con file all'interno o con un id univoco all'interno con tutti i tuoi file

Param	Inserisci	Descrizione
options	DownloadOptions	Il {@link} Opzioni di downloadScarica un nuovo file zip.

Ritorna: Promise<BundleInfo>

---

next(…

next(options: BundleId) => Promise<BundleInfo>

Imposta il bundle successivo da utilizzare quando l'app viene riavviata.

Param	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Bundle da impostare alla prossima avviatura dell'app. {@link}

BundleInfo.id Promise<BundleInfo>

---

Ritorna:

set(options: BundleId) => Promise<void>

Copia negli appunti

Imposta il bundle corrente e carica immediatamente l'app.	Tipo	Descrizione
options	BundleId	Un {@link} BundleIdOggetto contenente l'ID del pacchetto nuovo da impostare come attuale.

---

elimina(…).

delete(options: BundleId) => Promise<void>

Elimina il bundle specificato dallo storage dell'app nativa. Utilizza con {@link list} per ottenere gli ID dei Bundle archiviati.

Parametri	Tipo	Descrizione
options	BundleId	Un {@link} BundleId} oggetto contenente l'ID di un bundle da eliminare (nota, si tratta dell'ID del bundle, NON del nome della versione)

---

elenco(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Ottieni tutti i bundle scaricati localmente nell'app

Param	Tipo	Descrizione
options	ListOptions	Il {@link} Opzioni della lista} per elencare i bundle

Restituisce: Promise<BundleListResult>

---

reset(…)

reset(options?: ResetOptions | undefined) => Promise<void>

Ripristina l'applicazione al builtin bundle (il bundle inviato a Apple App Store / Google Play Store ) o al bundle caricato con successo più recente.

Parametro	Tipo	Descrizione
options	ResetOptions	Contenente {@link ResetOptions.toLastSuccessful}, true si riavvia al bundle predefinito e false si riavvierà al bundle caricato con successo l'ultima volta.

---

current()

current() => Promise<CurrentBundleResult>

Restituisce il bundle corrente, se non sono impostati restituisce builtin. currentNative è il bundle originale installato sul dispositivo

Ritorna: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Ricarica la vista

---

setMultiDelay(…

setMultiDelay(options: MultiDelayConditions) => Promise<void>

Imposta un {@link} Condizione di ritardoarray contenente le condizioni che il Plugin utilizzerà per ritardare l'aggiornamento. Dopo che tutte le condizioni sono state soddisfatte, il processo di aggiornamento verrà eseguito di nuovo come di consueto, quindi l'aggiornamento verrà installato anche se l'app è in background o è stata chiusa. date La data deve essere un stringa di data ISO 8601. background Il valore dovrebbe essere un numero in millisecondi. nativeVersion Il tipo deve essere "versione" e il valore deve essere il numero di versione. kill Il tipo di evento non viene utilizzato.\La funzione presenta comportamento non coerente: l'opzione "kill" attiva l'aggiornamento dopo la prima esecuzione e non dopo la successiva esecuzione in background, come fanno le altre opzioni. Questo verrà risolto in una futura versione maggiore.

Param	Tipo	Descrizione
options	MultiDelayConditions	Contiene l'array di condizioni {@link MultiDelayConditions} per impostare

Dal: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Annulla una {@link DelayCondition} per elaborare un aggiornamento immediatamente.

Dal: 4.0.0

---

Ottieni l'ultima versione disponibile da URL di aggiornamento

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Ottieni l'ultima versione disponibile da URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Ritorna: Promise<LatestVersion>

Dal: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Imposta il canale per questo dispositivo. Il canale deve essere allow_device_self_set funziona per questo.

Note importanti:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizzare invece il defaultChannel in your Capacitor config instead.
• I canali pubblici non possono essere assegnati automaticamente.
• Se un canale è contrassegnato come , chiamando publicritornerà un errore. Per utilizzare un canale pubblico, chiamare setChannel() invece - il dispositivo si auto-abbasserà automaticamente al canale pubblico corrispondente. unsetChannel() Utilizzare
• per scoprire quali canali sono disponibili e se consentono l'assegnazione automatica. listChannels() enabled for this to work.

Parametro	Tipo	Descrizione
options	SetChannelOptions	È il {@link Imposta le opzioni del canale} il canale da impostare

Ritorna: Promise<ChannelRes>

Dal: 4.7.0

---

unsetChannel(…)

unsetChannel(options: UnsetChannelOptions) => Promise<void>

Svuota l'override del canale per questo dispositivo. Dopo aver chiamato questo metodo, il dispositivo riceverà automaticamente gli aggiornamenti dal canale pubblico che corrisponde alle sue condizioni (piattaforma, tipo di dispositivo, tipo di build).

È utile quando:

• Vuoi spostare un dispositivo sulla pista di aggiornamento predefinita
• Vuoi utilizzare un canale pubblico (poiché i canali pubblici non possono essere assegnati autonomamente tramite setChannel())

Param	Tipo
options	UnsetChannelOptions

Da: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Restituisce: Promise<GetChannelRes>

Dal: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Elenco di tutti i canali disponibili per questo dispositivo. Restituisce i canali compatibili con l'ambiente corrente del dispositivo (piattaforma, emulatore/dispositivo reale, build di sviluppo/produttivo) e sono o pubblici o consentono l'assegnazione da parte dell'utente.

Ogni canale nella risposta include:

• publicSe truequesto è un canale predefinito. Non puoi assegnare a te stesso a questo canale utilizzando setChannel() . Invece, se rimuovi l'assegnazione del canale utilizzando unsetChannel()Il dispositivo riceverà automaticamente aggiornamenti da questo canale pubblico.
• allow_self_setSe truequesto è un canale assegnabile da parte dell'utentePuoi assegnare esplicitamente il dispositivo a questo canale utilizzando setChannel().

Ritorna: Promise<ListChannelsResult>

Dal: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>

Imposta un ID personalizzato per questo dispositivo

Param	Tipo	Descrizione
options	SetCustomIdOptions	è il {@link __CAPGO_KEEP_0__} customId da impostare

Dal: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ottieni la versione dell'app nativa o la versione integrata se impostata nella configurazione

Ritorna: Promise<BuiltinVersion>

Dal: 5.2.0

---

ottiene l'ID del dispositivo()

getDeviceId() => Promise<DeviceId>

Ottenere l'ID univoco utilizzato per identificare il dispositivo (inviato al server di aggiornamento automatico)

Ritorna: Promise<DeviceId>

---

ottiene la versione del plugin nativo()

getPluginVersion() => Promise<PluginVersion>

Ottenere la versione del plugin Updater nativo Capacitor (inviata al server di aggiornamento automatico)

Ritorna: Promise<PluginVersion>

---

è abilitato l'aggiornamento automatico()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottieni lo stato della configurazione di aggiornamento automatico.

Restituisce: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimina tutti gli ascoltatori per questo plugin.

Dal: 1.0.0

---

addListener('download', …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

Ascolta l'evento di download del pacchetto nell'app. Si attiva una sola volta quando inizia il download, durante il download e quando è completato. Questo ti restituirà tutti i percentuali di download durante il download

Parametro	Tipo
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 2.0.11

---

addListener(‘noNeedUpdate’, …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Ascolta l'evento di non aggiornamento necessario, utile quando desideri eseguire il controllo ogni volta che l'app viene avviata

Parametro	Tipo
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

Aggiungi ascoltatore(‘aggiornamento disponibile’, …)

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

Ascolta l'evento di aggiornamento disponibile, utile quando desideri eseguire una verifica ogni volta che l'app viene avviata

Parametro	Tipo
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Ritorna: Promise<PluginListenerHandle>

Dal: 4.0.0

---

Aggiungi ascoltatore(‘download completato’, …)

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

Ascolta gli eventi di download completato.

Parametro	Tipo
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Ritorna: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener(‘aggiornamento maggiore’, …)

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

Ascolta l'evento di aggiornamento maggiore dell'applicazione, informa quando l'aggiornamento maggiore è bloccato impostando disableAutoUpdateBreaking

Parametro	Tipo
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Ritorna: Promise<PluginListenerHandle>

Dal: 2.3.0

---

Aggiungi ascoltatore di evento di aggiornamento fallito in App, ti avvisa quando l'aggiornamento non riesce ad installarsi alla prossima avviatura dell'app

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Ascolta evento di fallimento dell'aggiornamento nell'App, ti avvisa quando l'aggiornamento non riesce ad installarsi alla prossima avviatura dell'app

Parametro	Tipo
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Ritorna: Promise<PluginListenerHandle>

Dal: 2.3.0

---

Aggiungi ascoltatore di evento di download fallito in App, ti avvisa quando un download di bundle ha fallito

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

Ascolta evento di fallimento del download nell'App, ti avvisa quando un download di bundle ha fallito

Parametro	Tipo
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

Aggiungi ascoltatore per l'evento di ricarica dell'applicazione, informa quando la ricarica è avvenuta

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Ascolta l'evento di ricarica dell'applicazione, informa quando la ricarica è avvenuta

Parametro	Tipo
eventName	’appReloaded’
listenerFunc	() => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.3.0

---

Aggiungi ascoltatore per l'evento 'appReady', …

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Ascolta l'evento 'appReady' dell'applicazione, ti informa quando l'app è pronta per l'uso

Parametro	Tipo
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Restituisce: Promise<PluginListenerHandle>

Da: 5.1.0

---

èDisponibileAggiornamentoAutomatico()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Restituisce se è disponibile l'aggiornamento automatico (non disabilitato da serverUrl).

Restituisce: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ottenere il prossimo pacchetto che verrà utilizzato quando l'app viene riavviata. Restituisce null se non è impostato un prossimo pacchetto.

Restituisce: Promise<BundleInfo | null>

Dal: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

Abilita o disabilita il menu di scuotimento per scopi di debug/test

Param	Tipo	Descrizione
options	SetShakeMenuOptions	Contiene booleano abilitato per abilitare o disabilitare il menu a scuotimento

Da: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu a scuotimento

Ritorna: Promise<ShakeMenuEnabled>

Da: 7.5.0

---

Interfacce

AppReadyResult

Proprietà	Tipo
bundle	BundleInfo

Informazioni sul pacchetto

Proprietà	Tipo
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

URL di aggiornamento

Proprietà	Tipo
url	string

URL delle statistiche

Proprietà	Tipo
url	string

URL del canale

Proprietà	Tipo
url	string

Opzioni di download

Questa URL e le versioni vengono utilizzate per scaricare il bundle dal server. Se si utilizza il backend, tutte le informazioni saranno fornite dal metodo getLatest. Se non si utilizza il backend, è necessario fornire l'URL e la versione del bundle. Il checksum e la sessionKey sono richiesti se si è criptato il bundle con il comando CLI encrypt, dovrebbero essere ricevuti come risultato del comando.

Proprietà	Tipo	Descrizione	Predefinito	Dal
url	string	L'URL del file zip del bundle (ad esempio: dist.zip) da scaricare. (Questo può essere qualsiasi URL. Ad esempio: Amazon S3, un GitHub tag, qualsiasi altro posto in cui hai ospitato il tuo bundle.)
version	string	La versione code/nome di questo bundle/versione
sessionKey	string	La chiave della sessione per l'aggiornamento, quando il bundle è crittografato con una chiave di sessione	undefined	4.0.0
checksum	string	Il checksum per l'aggiornamento, dovrebbe essere in sha256 e crittografato con la chiave privata se il bundle è crittografato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per Delta (manifesto) scarichi multi-file	undefined	6.1.0

ManifestoEntry

Prop	Tipo
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Proprietà	Tipo
id	string

Risultato della lista Bundle

Proprietà	Tipo
bundles	BundleInfo[]

Opzioni della lista

Proprietà	Tipo	Descrizione	Predefinito	Da
raw	boolean	Se vero, il elenco cercherà di leggere la database interna al posto dei file sul disco.	false	6.14.0

Resetta le opzioni

Proprietà	Tipo
toLastSuccessful	boolean

Risultato Bundle corrente

Proprietà	Tipo
bundle	BundleInfo
native	string

Condizioni di ritardo multipli

Proprietà	Tipo
delayConditions	DelayCondition[]

Condizione di ritardo

Proprietà	Tipo	Descrizione
kind	DelayUntilNext	Impostare le condizioni di ritardo in setMultiDelay
value	string

Ultima versione

Proprietà	Tipo	Descrizione	Dal
version	string	Risultato del metodo getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

OttenereUltimaVersione

Proprietà	Tipo	Descrizione	Predefinito	Dal
channel	string	Il canale per ottenere la versione più recente per Il canale deve consentire ‘self_assign’ per far funzionare questo	undefined	6.8.0

CanaleRes

Proprietà	Tipo	Descrizione	Dal
status	string	Stato corrente del canale impostato	4.7.0
error	string
message	string

ImpostaCanale

Proprietà	Tipo
channel	string
triggerAutoUpdate	boolean

Imposta non definita per il canale

Proprietà	Tipo
triggerAutoUpdate	boolean

Ottieni canale

Proprietà	Tipo	Descrizione	Dal
channel	string	Stato corrente di ottieni canale	4.8.0
error	string
message	string
status	string
allowSet	boolean

Lista dei canali

Proprietà	Tipo	Descrizione	Dal
channels	ChannelInfo[]	Elenco dei canali disponibili	7.5.0

Informazioni sul canale

Proprietà	Tipo	Descrizione	Dal momento in cui
id	string	L'ID del canale	7.5.0
name	string	Il nome del canale	7.5.0
public	boolean	Se vero, si tratta di un canale predefinito/fallback. I dispositivi non possono assegnarsi automaticamente ai canali pubblici. Al contrario, quando un dispositivo elimina la sua sovrascrittura del canale (utilizzando unsetChannel()), riceverà automaticamente aggiornamenti dal canale pubblico corrispondente.	7.5.0
allow_self_set	boolean	Se vero, i dispositivi possono assegnarsi esplicitamente a questo canale utilizzando setChannel(). Ciò è tipicamente utilizzato per test di beta, test A/B o tracce di aggiornamento a richiesta.	7.5.0

Imposta le opzioni per l'ID personalizzato

Proprietà	Tipo
customId	string

Versione predefinita integrata

Proprietà	Tipo
version	string

Id dispositivo

Proprietà	Tipo
deviceId	string

Versione plugin

Tipo	Versione plugin
version	string

Proprietà di aggiornamento automatico abilitato

Proprietà	Tipo
enabled	boolean

Handle dell'ascoltatore di plugin

Proprietà	Tipo
remove	() => Promise<void>

Evento di download

Proprietà	Tipo	Descrizione	Dal momento in cui
percent	number	Stato corrente del download, compreso tra 0 e 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Proprietà	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Stato corrente del download, compreso tra 0 e 100.	4.0.0

UpdateAvailableEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Stato corrente del download, tra 0 e 100.	4.0.0

DownloadCompleteEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Emesso quando è disponibile un nuovo aggiornamento.	4.0.0

MajorAvailableEvent

Proprietà	Tipo	Descrizione	Da
version	string	Emette quando è disponibile un nuovo bundle maggiore.	4.0.0

UpdateFailedEvent

Proprietà	Tipo	Descrizione	Da
bundle	BundleInfo	Emitto quando un aggiornamento non riesce ad installarsi.	4.0.0

DownloadFailedEvent

Proprietà	Tipo	Descrizione	Dal
version	string	Emitto quando un download fallisce.	4.0.0

AppReadyEvent

Proprietà	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Emesso quando l'app è pronta per essere utilizzata.	5.2.0
status	string

Aggiornamento automatico disponibile

Proprietà	Tipo
available	boolean

Imposta opzioni del menu Shake

Proprietà	Tipo
enabled	boolean

ShakeMenu abilitato

Proprietà	Tipo
enabled	boolean

Alias di tipo

Stato del pacchetto

in attesa: Il pacchetto è in attesa di essere scaricato. IMPOSTA come il prossimo pacchetto. downloading: Il pacchetto è in fase di download. IMPOSTA come il prossimo pacchetto. el caso di successo: Il pacchetto è stato scaricato e è pronto per essere impostato come il prossimo pacchetto. errore: Il pacchetto non è stato possibile scaricare.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

Ritardi fino al prossimo

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’