Class AppConfiguration

Uma classe que expõe opções de configuração para um aplicativo.

Herança

objeto

AppConfiguration

namespace: Realms.sincronizar

Conjunto: Realm.exe

Sintaxe

public class AppConfiguration

Construtores

AppConfiguration(string)

Inicializa uma nova instância da classe AppConfiguration com o appId especificado.

Declaração

public AppConfiguration(string appId)

Parâmetros

Tipo	Nome	Descrição
string	appId	O ID do aplicativo Atlas App Services.

Propriedades

appId

Obtém o ID do aplicativo exclusivo que identifica a aplicação Realm.

Declaração

public string AppId { get; }

Valor da propriedade

Tipo	Descrição
string	O ID do aplicativo Atlas App Services.

BaseFilePath

Obtém ou define a pasta raiz em relação à qual todos os dados locais desse aplicativo serão armazenados. Esses dados incluem metadados para usuários e Realms sincronizados.

Declaração

public string BaseFilePath { get; set; }

Valor da propriedade

Tipo	Descrição
string	O caminho base do aplicativo.

BaseUri

Obtém ou define a URL base para este aplicativo Realm.

Declaração

public Uri BaseUri { get; set; }

Valor da propriedade

Tipo	Descrição
Uri	A URL base do aplicativo.

Observações

Isso só precisa ser definido se, por algum motivo, seu aplicação não estiver hospedado em services.cloud.mongodb.com. Esse geralmente é o caso da sincronização com um servidor de borda.

DefaultRequestTimeout

Obtém ou define o tempo limite de solicitação padrão para solicitações HTTP para o MongoDB Atlas. O padrão é 1 minuto.

Declaração

public TimeSpan DefaultRequestTimeout { get; set; }

Valor da propriedade

Tipo	Descrição
TimeSpan	O tempo limite de solicitação HTTP padrão.

HttpClientHandler

Obtém ou define o HttpMessageHandler que será usado para as solicitações HTTP para o MongoDB Atlas.

Declaração

public HttpMessageHandler? HttpClientHandler { get; set; }

Valor da propriedade

Tipo	Descrição
HttpMessageHandler	O manipulador de cliente HTTP que configura itens como certificados e configurações de proxy.

Observações

Você pode usar isso para substituir o manipulador de cliente HTTP padrão e definir configurações como proxies, certificados de cliente e cookies. Embora eles não sejam necessários para se conectar ao MongoDB Atlas em circunstâncias normais, eles podem ser úteis se os dispositivos do cliente estiverem atrás de um firewall corporativo ou usarem uma configuração de rede mais complexa.

LocalAppName

Obtém ou define o nome do aplicativo local.

Declaração

[Obsolete("This property has no effect and will be removed in a future version.")]
public string? LocalAppName { get; set; }

Valor da propriedade

Tipo	Descrição
string	O nome amigável que identifica o aplicativo cliente atual.

LocalAppVersion

Obtém ou define a versão do aplicativo local.

Declaração

[Obsolete("This property has no effect and will be removed in a future version.")]
public string? LocalAppVersion { get; set; }

Valor da propriedade

Tipo	Descrição
string	A versão do aplicativo cliente.

Veja também

LocalAppName

MetadataEncryptionKey

Obtém ou define a chave de criptografia para os metadados do usuário neste dispositivo.

Declaração

public byte[]? MetadataEncryptionKey { get; set; }

Valor da propriedade

Tipo	Descrição
byte[]	A chave de criptografia de metadados do usuário.

Observações

Isso não alterará a chave de criptografia para Realms individuais. Isso ainda deve ser definido em EncryptionKey ao abrir o Realm.

MetadataPersistenceMode

Obtém ou define o modo de persistência para os metadados do usuário neste dispositivo.

Declaração

public MetadataPersistenceMode? MetadataPersistenceMode { get; set; }

Valor da propriedade

Tipo	Descrição
MetadataPersistenceMode?	O modo de persistência de metadados do usuário.

Observações

O valor padrão é Encrypted para dispositivos iOS e NotEncrypted para todas as outras plataformas. No iOS, nos integramos ao chaveiro do sistema para gerar e armazenar uma chave de criptografia aleatória na primeira vez que o aplicativo é iniciado. Em outras plataformas, MetadataEncryptionKey precisa ser definido se Encrypted for especificado.

OnSyncWebSocketConnection

Obtém ou define o delegado que será usado para configurar conexões de WebSocket de saída para o MongoDB Atlas.

Declaração

public Action<ClientWebSocketOptions>? OnSyncWebSocketConnection { get; set; }

Valor da propriedade

Tipo	Descrição
ação<ClientWebSocketOptions>	O delegado que será usado para configurar as conexões do WebSocket de saída.

Observações

Você pode usar isso para modificar o comportamento padrão do ClientWebSocket . Normalmente, isso não é necessário para se conectar ao MongoDB Atlas, mas pode ser útil se os dispositivos cliente estiverem atrás de um firewall corporativo ou usarem uma configuração de rede mais complexa. Requer que UseManagedWebSockets esteja definido como true.

SyncTimeoutOptions

Obtém ou define as opções para os tipos diversos de tempos limite de conexão para conexões de sincronização abertas para esse aplicativo.

Declaração

public SyncTimeoutOptions SyncTimeoutOptions { get; set; }

Valor da propriedade

Tipo	Descrição
SyncTimeoutOptions	As opções de tempo limite de sincronização aplicadas aos Realms sincronizados.

UseAppCache

Obtém ou define um valor que indica se as instâncias de aplicativo criadas com essa configuração devem ser armazenadas em cache.

Declaração

public bool UseAppCache { get; set; }

Valor da propriedade

Tipo	Descrição
bool	true se o aplicativo deve ser armazenado em cache; false caso contrário. O valor padrão é true.

Observações

Quando um aplicativo é criado usando Create(AppConfiguration), o comportamento padrão é obter ou adicionar a instância do aplicativo a partir de um cache criptografado no ID do aplicativo. Isso oferece certos benefícios de desempenho ao chamar Create(AppConfiguration) várias vezes.

UseManagedWebSockets

Obtém ou define um valor que indica se o cliente .NET WebSocket ou o cliente Realm WebSocket integrado será usado para o tráfego de sincronização.

Declaração

public bool UseManagedWebSockets { get; set; }

Valor da propriedade

Tipo	Descrição
bool	true para usar o ClientWebSocket; false para usar o cliente Realm WebSocket integrado.

Observações

O valor padrão é false, mas isso será alterado em uma versão futura.

Veja também

OnSyncWebSocketConnection