Construtores

Acessores

  • get config(): SyncConfiguration
  • Obtém a parte Sync da configuração com a qual o Realm correspondente foi construído.

    Retorna SyncConfiguration

  • obter connectionState(): ConnectionState
  • Obtém o estado atual da conexão com o servidor. Várias sessões podem compartilhar a mesma conexão subjacente. Nesse caso, qualquer alteração de conexão é enviada para todas as sessões.

    Os dados só serão sincronizados com o servidor se esse método retornar Connected e state() retornar Active ou Dying.

    Retorna ConnectionState

  • obter estado(): SessionState
  • Obtém o estado atual da sessão.

    Retorna o estado da sessão

  • obter URL(): string
  • Obtém a URL do servidor Objeto de Realm ao qual esta sessão está conectada.

    Retorna a string

Métodos

  • Registra uma notificação de conexão no objeto da sessão. Ele será notificado sobre alterações na conexão subjacente com o Servidor de objetos de Realm.

    Parâmetros

    • chamada de resposta: ConnectionNotificationCallback

      Chamado com os seguintes argumentos:

      1. newState: O novo estado da conexão
      2. oldState: o estado do qual a conexão fez a transição.

    Retorna nulo

    desde

    2.15.0

  • Registre uma chamada de resposta de notificação de progresso em um objeto de sessão

    Parâmetros

    • Direção: ProgressDirection

      A direção de progresso a ser registrada.

    • modo: ProgressMode

      O modo de notificação de progresso a ser usado para o registro. Pode ser um dos seguintes:

      • reportIndefinitely - o registro permanecerá ativo até que a chamada de resposta seja cancelada
      • forCurrentlyOutstandingWork - o registro estará ativo até que somente os bytes atualmente transferíveis sejam sincronizados
    • chamada de resposta: ProgressNotificationCallback

      Chamado com os seguintes argumentos:

      1. transferred: O número atual de bytes já foi transferido
      2. transferable: O número total de bytes transferíveis (o número de bytes já transferidos mais o número de bytes pendentes de transferência)

    Retorna nulo

    desde

    1.12.0

  • Esse método retorna uma promessa que não é resolvida com êxito até que todas as alterações remotas conhecidas tenham sido baixadas e aplicadas ao Realm ou que o tempo limite especificado seja atingido, caso em que ele será rejeitado. Se o método expirar, o download ainda continuará em segundo plano.

    Este método não pode ser chamado antes que o Realm seja aberto.

    Parâmetros

    • Optional timeoutMs: número

      quantidade máxima de tempo para esperar em milissegundos antes que a promessa seja rejeitada. Se nenhum tempo limite for especificado, o método aguardará para sempre.

    Retorna a Promessa<null>

  • Retorna true se a sessão estiver atualmente ativa e conectada ao servidor, false caso contrário.

    Retorna booleano

  • Pausar uma sessão de sincronização.

    Esse método é assíncrono; portanto, para saber quando a sessão começou, você precisará adicionar uma notificação de conexão com addConnectionNotification .

    Esse método é idempotente, portanto, será autônomo se a sessão já estiver pausada ou se a multiplexação estiver habilitada.

    Retorna nulo

    desde

    2.16.0-rc.2

  • Reconecta ao Altas Realm Mobile Sync.

    Esse método é assíncrono; portanto, para saber quando a sessão começou, você precisará adicionar uma notificação de conexão com addConnectionNotification .

    Este método é idempotente, portanto, será um no-op se a sessão já tiver sido iniciada.

    Retorna nulo

    desde

    12.2.0

  • Cancele o registro de uma chamada de resposta de notificação de estado que foi registrado anteriormente com addStateNotification. Chamar a função várias vezes com a mesma chamada de resposta é ignorado.

    Parâmetros

    Retorna nulo

    desde

    2.15.0

  • Cancele o registro de um retorno de chamada de notificação de progresso que foi registrado anteriormente com addProgressNotification . Chamar a função várias vezes com o mesmo retorno de chamada é ignorado.

    Parâmetros

    Retorna nulo

    desde

    1.12.0

  • Retoma uma sessão de sincronização que foi pausada.

    Esse método é assíncrono; portanto, para saber quando a sessão começou, você precisará adicionar uma notificação de conexão com addConnectionNotification .

    Esse método é idempotente, portanto, será autônomo se a sessão já tiver sido iniciada ou se a multiplexação estiver habilitada.

    Retorna nulo

    desde

    2.16.0-rc.2

  • Esse método retorna uma promessa que não é resolvida com êxito até que todas as alterações locais conhecidas tenham sido carregadas no servidor ou que o tempo limite especificado seja atingido, caso em que ela será rejeitada. Se o método expirar, o carregamento continuará em segundo plano.

    Este método não pode ser chamado antes que o Realm seja aberto.

    Parâmetros

    • Optional timeoutMs: número

      Quantidade máxima de tempo para esperar em milissegundos antes que a promessa seja rejeitada. Se nenhum tempo limite for especificado, o método aguardará para sempre.

    Retorna a Promessa<null>

Gerado usando TypeDoc