Conjunto de assinaturas de interface
Nesta página
io.realm.mongodb.sync
Interfaces implementadas:
Um conjunto de assinatura é uma visão imutável de todas as assinaturas atuais para um determinado Realm que foi configurado para flexible sync.
O Flexible Sync é uma maneira de definir quais dados são sincronizados de e para o dispositivo usando o RealmQuery s. A query e seus metadados são representados por uma inscrição .
Um conjunto de assinaturas define, portanto, todos os dados que estão disponíveis para o dispositivo e que estão sendo sincronizados com o servidor. Se o conjunto de assinaturas encontrar um erro, por exemplo, contendo uma query inválida, todo o conjunto de assinaturas entrará em um estado SubscriptionSet.State.ERROR e nenhuma sincronização ocorrerá até que o erro seja corrigido.
Se uma assinatura for removida, os dados correspondentes também serão, mas ela será removida apenas do dispositivo. Ele não é excluído no servidor.
É possível modificar um conjunto de assinatura enquanto estiver off-line, mas a modificação não é aceita pelo servidor antes que getState() retorne SubscriptionSet.State.COMplete .
É possível forçar a sincronização do conjunto de assinatura com o servidor usando waitForSynchronization() e suas variantes.
Resumo da classe aninhada
Modificador e tipo | Classe e descrição |
|---|---|
public static final | |
public static interface | |
public static interface | |
public static interface |
Resumo do método
Modificador e tipo | Método e descrição |
|---|---|
inscriçãopública | |
inscriçãopública | Encontre a primeira assinatura que contém a query fornecida. |
Se getState() retornar State.ERROR , este método retornará o motivo. | |
subscriptionSet.Statepúblico | getState () Retorna o estado atual do SubscriptionSet. |
public int | size () Retorna quantas assinaturas estão atualmente neste conjunto de assinaturas. |
Conjunto de Assinaturaspúblicas | Modifique o conjunto de assinaturas. |
RealmAsyncTaskpúblico | Modifique de forma assíncrona o conjunto de assinaturas. |
booleanopúblico | Aguarde o conjunto de subscrições sincronizar com o servidor. |
booleanopúblico | Aguarde o conjunto de subscrições sincronizar com o servidor. |
RealmAsyncTaskpúblico | ) Aguarde de forma assíncrona o conjunto de assinaturas sincronizar com o servidor. |
RealmAsyncTaskpúblico | Aguarde de forma assíncrona o conjunto de assinaturas sincronizar com o servidor. |
Métodos herdados
Detalhes do método
find
Encontre a assinatura com um nome fornecido. Parâmetros
Devoluções a assinatura correspondente ou |
Encontre a primeira assinatura que contém a query fornecida. É possível que várias assinaturas nomeadas contenham a mesma query. Parâmetros
Devoluções a primeira assinatura contendo a query ou |
Obter mensagem de erro
public String getErrorMessage () |
|---|
Se getState() retornar State.ERROR , este método retornará o motivo. Os erros podem ser corrigidos modificando a assinatura adequadamente e, em seguida, chamando waitForSynchronization() . Devoluções o erro subjacente se o conjunto de assinatura estiver no estado State.ERROR . Para todos os outros estados, |
Obter estado
public SubscriptionSet.State getState () |
|---|
Retorna o estado atual do SubscriptionSet. Consulte SubscriptionSet.State para obter mais detalhes sobre cada estado. Devoluções estado atual do SubscriptionSet. |
Tamanho
public int size () |
|---|
Retorna quantas assinaturas estão atualmente neste conjunto de assinaturas. Devoluções o número de assinaturas no conjunto de assinaturas. |
update
Modifique o conjunto de assinaturas. Se uma exceção for lançada durante a atualização, nenhuma alteração será aplicada. Se a atualização for bem-sucedida, esse conjunto de assinaturas será atualizado com o estado modificado. Parâmetros
Devoluções este conjunto de assinaturas, que agora foi atualizado. Lança
|
updateAsync
Modifique de forma assíncrona o conjunto de assinaturas. Se uma exceção for lançada durante a atualização, nenhuma alteração será aplicada. * Parâmetros
Devoluções tarefa que controla a execução assíncrona. |
Aguarde a sincronização
Aguarde até que o conjunto de assinatura sincronize com o servidor. Ele retornará quando o servidor aceitar o conjunto de queries e tiver baixado os dados para elas, ou se ocorrer um erro. Observe que você precisará chamar manualmente o realm Realm() ou aguardar que os ouvintes de alterações sejam trigger para ver os dados baixados. Se ocorrer um erro, o motivo subjacente pode ser encontrado por meio de getErrorMessage() . Parâmetros
Devoluções
Lança
|
public boolean waitForSynchronization () |
|---|
Aguarde até que o conjunto de assinatura sincronize com o servidor. Ele retornará quando o servidor aceitar o conjunto de queries e tiver baixado os dados para elas, ou se ocorrer um erro. Observe que você precisará chamar manualmente o realm Realm() ou aguardar que os ouvintes de alterações sejam trigger para ver os dados baixados. Se ocorrer um erro, o motivo subjacente pode ser encontrado por meio de getErrorMessage() . Devoluções
|
waitForSynchronizationAsync
) |
|---|
Aguarde de forma assíncrona que o conjunto de assinaturas sincronize com o servidor. O retorno de chamada é invocado quando o servidor aceita o conjunto de queries e baixou dados para eles, ou se ocorrer um erro. Observe que você precisará chamar manualmente Realm.refresh() ou aguardar que os ouvintes de alterações sejam trigger para ver os dados baixados. Se ocorrer um erro, o motivo subjacente pode ser encontrado por meio de getErrorMessage() . Parâmetros
Devoluções
|
Aguarde de forma assíncrona que o conjunto de assinaturas sincronize com o servidor. Ele invocará o retorno de chamada quando o servidor aceitar o conjunto de queries e tiver baixado dados para eles, ou se ocorrer um erro. Observe que você precisará chamar manualmente Realm.refresh() ou aguardar que os ouvintes de alterações sejam trigger para ver os dados baixados. Se ocorrer um erro, o motivo subjacente pode ser encontrado por meio de getErrorMessage() . Parâmetros
Devoluções
|