Realm JavaScript

Realm~App.Sync.MutableSubscriptionSet

A versão mutável de um determinado SubscriptionSet. Os métodos mutáveis de uma determinada instância Realm.App.Sync.SubscriptionSet só podem ser acessados de dentro da chamada de resposta Realm.App.Sync.SubscriptionSet#update .

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

adicionar(query, opções)Realm.App.Sync.Subscription

Adiciona uma query ao conjunto de assinaturas ativas. A query será unida por meio de um operador OR com quaisquer queries existentes para o mesmo tipo.

Uma query é representada por uma instância Realm.Results retornada de Realm#objects, por exemplo: mutableSubs.add(realm.objects("Cat").filtered("age > 10"));.

Parâmetros:
Retorna: Realm.App.Sync.Subscription A nova inscrição.
remover(query)boolean

Remove uma assinatura com a query fornecida do SubscriptionSet.

Parâmetros:
Retorna: boolean true se a assinatura foi removida, false se não foi encontrada.
Remover todos()number

Remove todas as assinaturas do conjunto de assinaturas.

Retorna: number O número de assinaturas removidas.
removeByName(nome)boolean

Remove uma assinatura com o nome fornecido do SubscriptionSet.

Parâmetros:
  • name
    • Tipo: string

    • O nome da assinatura a ser removida.

Retorna: boolean true se a assinatura foi removida, false se não foi encontrada.
removeByObjectType(objectType)number

Remove todas as assinaturas do Tipo de objeto de Realm especificado do SubscriptionSet.

Parâmetros:
  • objectType
    • Tipo: string

    • O nome da string do Tipo de objeto de Realm para remover todas as assinaturas.

Retorna: number O número de assinaturas removidas.
removeSubscription(inscrição)boolean

Remove a assinatura especificada do SubscriptionSet.

Parâmetros:
Retorna: boolean true se a assinatura foi removida, false se não foi encontrada.

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