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 modificado dentro de uma chamada de resposta SubscriptionSet.update , chamando métodos na instância MutableSubscriptionSet correspondente.

hierarquia (visualização completa)

Construtores

Acessores

  • obter erro(): nulo | corda
  • Se state for SubscriptionSetState.Error, esta será uma string representando por que o SubscriptionSet está em um estado de erro. Se não houver erro, será null .

    Retorna nulo | corda

    Uma string representando o erro ou null se não houver nenhum erro.

  • get isEmpty(): booleano
  • Se não há assinaturas no conjunto.

    Retorna booleano

    true se não houver assinaturas no conjunto, false caso contrário.

  • obter comprimento(): número
  • Retorna número

    O número de assinaturas no conjunto.

  • obter estado(): SubscriptionSetState
  • Retorna SubscriptionSetState

    O estado do SubscriptionSet.

  • obter versão(): número
  • A versão do SubscriptionSet. Isto é incrementado toda vez que um SubscriptionSet.update é aplicado.

    Retorna número

    A versão do SubscriptionSet.

Métodos

  • Torna o conjunto de assinaturas iterável.

    Retorna IterableIterator<Assinatura>

    Iterável de cada valor no conjunto.

    Exemplo

    for (const subscription of subscriptions) {
    // ...
    }
  • Encontre uma assinatura por nome.

    Parâmetros

    • nome: string

      O nome a ser pesquisado.

    Retorna nulo | inscrição

    A assinatura nomeada ou null se a assinatura não for encontrada.

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

    Parâmetros de tipo

    • inscrição

    Parâmetros

    Retorna nulo | inscrição

    A assinatura com a query especificada ou null se a assinatura não for encontrada.

  • Chame isso para fazer alterações nesse SubscriptionSet de dentro da chamada de resposta, como adicionar ou remover assinaturas do conjunto.

    O argumento MutableSubscriptionSet só pode ser usado a partir da chamada de resposta e não deve ser usado após o retorno.

    Todas as alterações feitas pela chamada de resposta serão agrupadas e enviadas ao servidor. Você pode await a chamada para update ou chamar SubscriptionSet.waitForSynchronization para aguardar a disponibilidade dos novos dados.

    Parâmetros

    • callback: ((mutableSubscriptions, Realm) => void)

      Uma função de chamada de resposta que recebe uma instância 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 FlexibleSyncConfiguration).

    Retorna a Promessa<null>

    Uma promessa que é resolvida quando o SubscriptionSet é sincronizado ou é rejeitada se houver um erro durante a sincronização (consulte SubscriptionSet.waitForSynchronization)

    Exemplo

    await realm.subscriptions.update(mutableSubscriptions => {
    mutableSubscriptions.add(realm.objects("Cat").filtered("age > 10"));
    mutableSubscriptions.add(realm.objects("Dog").filtered("age > 20"), { name: "oldDogs" });
    mutableSubscriptions.removeByName("youngDogs");
    });
    // `realm` will now return the expected results based on the updated subscriptions
  • Aguarde até que o servidor reconheça este conjunto de assinaturas e retorne os objetos correspondentes.

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

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

    Retorna a Promessa<null>

    Uma promessa que é resolvida quando a sincronização é concluída ou é rejeitada se houver um erro durante a sincronização.

Gerado usando TypeDoc