Realm JavaScript

Realm ~App .Sync . Conjunto de assinaturas

Classe que representa o conjunto de todas as assinaturas ativas de Flexible Sync para uma Instância de Realm.

O servidor avaliará continuamente as query em que a instância está inscrita e enviará os dados que correspondem a elas, bem como removerá os dados que não correspondem mais.

O conjunto de assinaturas só pode ser atualizado dentro de um chamada de resposta Realm.App.Sync.SubscriptionSet#update , chamando métodos na instância Realm.App.Sync.MutableSubscriptionSet correspondente.

Estende-se

Membros

Erro
Somente leitura

Se state for Realm.App.Sync.SubscriptionsState.Error, isso retornará um string representando por que o SubscriptionSet está em um estado de erro. null será retornado se não houver erro.

Tipo:
string ou null
isEmpty
Somente leitura

Retorna true se não houver assinaturas no conjunto; casofalse contrário, retorna .

Tipo:
boolean
Tamanho
Somente leitura

O número de assinaturas no conjunto.

Tipo:
number
state
Somente leitura

O estado do SubscriptionSet.

Tipo:
Realm.App.Sync.SubscriptionSetState
Versão
Somente leitura

A versão do SubscriptionSet. Isso é incrementado toda vez que um Realm.App.Sync.SubscriptionSet#update é aplicado.

Tipo:
number

Métodos

update(chamada de resposta)Promise<void>

Atualize o SubscriptionSet e altere esta instância para o ponto para o SubscriptionSet atualizado.

A adição ou remoção de assinaturas do conjunto deve ser executada dentro do argumento de chamada de resposta desse método, e os métodos mutados devem ser chamados com o argumento mutableSubs em vez da instância Realm.App.Sync.SubscriptionSet original.

Quaisquer alterações nas assinaturas após a execução da chamada de resposta serão agrupadas e enviadas ao servidor. Você pode await a chamada para update ou ligar para Realm.App.Sync.SubscriptionSet#waitForSynchronization para aguardar a disponibilidade dos novos dados.

Exemplo:

await realm.subscriptions.update(mutableSubs => {
  mutableSubs.add(realm.objects("Cat").filtered("age > 10"));
  mutableSubs.add(realm.objects("Dog").filtered("age > 20"));
  mutableSubs.removeByName("personSubs");
});
// `realm` will now return the expected results based on the updated subscriptions
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Uma função de chamada de resposta que recebe uma instância Realm.App.Sync.MutableSubscriptionSet como o primeiro argumento, que pode ser usada para adicionar ou remover assinaturas do conjunto, e o Realm associado ao SubscriptionSet como o segundo argumento (útil principalmente ao trabalhar com initialSubscriptions em Realm.App.Sync~FlexibleSyncConfiguration).

      Observação: a chamada de resposta não deve ser assíncrono.

Retorna: Promise<void> Uma promessa que resolve quando o SubscriptionSet é sincronizado ou é rejeitada se houver um erro durante a sincronização (consulte waitForSynchronisation)
Aguarde a sincronização()Promise<void>

Aguarde até que o servidor reconheça este conjunto de assinaturas e retorne os objetos correspondentes.

Se state for Realm.App.Sync.SubscriptionSetState.Complete, a promessa será resolvida imediatamente.

Se state for Realm.App.Sync.SubscriptionSetState.Error, a promessa será rejeitada imediatamente.

Retorna: Promise<void> Uma promessa que é resolvida quando a sincronização for concluída ou que é rejeitada se houver um erro durante a sincronização.

Métodos herdados

cada(chamada de resposta, esteArg)boolean
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.every
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto do SubscriptionSet. Se esta função retornar true para cada objeto, este método retornará true. Esta função usa três argumentos:

      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • esteArg opcional
    • Tipo: object

    • O valor de this quando callback é chamado.

Retorna: boolean representando se callback retornou true para cada objeto no SubscriptionSet.
Desde: 0.11.0
encontrarByName(nome)Realm.App.Sync.Subscription ou null

Encontre uma assinatura por nome.

Parâmetros:
  • name
    • Tipo: string

    • O nome a ser pesquisado.

Retorna: Realm.App.Sync.Subscription ou null A assinatura nomeada ou null se a assinatura não for encontrada.
encontrarByQuery(query)Realm.App.Sync.Subscription ou null

Encontre uma assinatura por query. Corresponderá a assinaturas nomeadas e não nomeadas.

Parâmetros:
  • Query
    • Tipo: Realm.Results

    • A query para pesquisar, representada como uma instância Realm.Results , por exemplo Realm.objects("Cat").filtered("age > 10").

Retorna: Realm.App.Sync.Subscription ou null A assinatura com a query especificada ou null se a assinatura não for encontrada.
forEach(chamada de resposta, esteArg)
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.forEach
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto do SubscriptionSet. Esta função usa três argumentos:

      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • esteArg opcional
    • Tipo: object

    • O valor de this quando callback é chamado.

Desde: 0.11.0
map(chamada de resposta, esteArg)[any, ...]
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.map
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto do SubscriptionSet. Esta função usa três argumentos:

      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • esteArg opcional
    • Tipo: object

    • O valor de this quando callback é chamado.

Retorna : [any, ...] – os valores de retorno de callback após ser chamado em cada objeto no SubscriptionSet.
Desde: 0.11.0
reduzir(callback, initialValue)any
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.reduce
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto do SubscriptionSet. Esta função usa quatro argumentos:

      • previousValue – O valor retornado anteriormente na última invocação da chamada de resposta, ou initialValue, se fornecido.
      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • initialValue opcional
    • Tipo: object

    • O valor a ser usado como primeiro argumento para a primeira chamada do callback.

Lança:
  • TypeError

    • Se o conjunto de assinaturas estiver vazio e nenhum initialValue foi fornecido.

Retorna: any – o valor retornado pela invocação final de callback, exceto para os seguintes casos especiais:
  • Se o SubscriptionSet consistir em um único objeto e nenhum initalValue tiver sido fornecido, esse objeto será retornado.
  • Se o SubscriptionSet estiver vazio, initialValue deverá ser fornecido e será retornado.
Desde: 0.11.0
reduzirDireita(callback, initialValue)any
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.reduceRight
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto, da direita para a esquerda, no SubscriptionSet. Esta função usa quatro argumentos:

      • previousValue – O valor retornado anteriormente na última invocação da chamada de resposta, ou initialValue, se fornecido.
      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • initialValue opcional
    • Tipo: object

    • O valor a ser usado como primeiro argumento para a primeira chamada do callback.

Lança:
  • TypeError

    • Se o conjunto de assinaturas estiver vazio e nenhum initialValue foi fornecido.

Retorna: any – o valor retornado pela invocação final de callback, exceto para os seguintes casos especiais:
  • Se o SubscriptionSet consistir em um único objeto e nenhum initalValue tiver sido fornecido, esse objeto será retornado.
  • Se o SubscriptionSet estiver vazio, initialValue deverá ser fornecido e será retornado.
Desde: 0.11.0
alguns(chamada de resposta, esteArg)boolean
Obsoleto: será removido na v12.0.0.
Consulte: Array.prototype.some
Parâmetros:
  • chamada de resposta
    • Tipo: function

    • Função a ser executada em cada objeto do SubscriptionSet. Se esta função retornar true , este método retornará true . Esta função usa três argumentos:

      • object – O objeto atual que está sendo processado no SubscriptionSet.
      • index – O índice do objeto que está sendo processado no SubscriptionSet.
      • subscriptionSet – O próprio conjunto de subscrições.
  • esteArg opcional
    • Tipo: object

    • O valor de this quando callback é chamado.

Retorna: boolean – true quando callback retorna true para um objeto no SubscriptionSet, caso contrário, false.
Desde: 0.11.0