SyncSubscriptionSet

@frozen
public struct SyncSubscriptionSet
extension SyncSubscriptionSet: Sequence

SyncSubscriptionSet é uma collection de SyncSubscriptions. Este é o ponto de entrada para adicionar e remover SyncSubscriptions.

Inicializadores

  • O número de assinaturas no conjunto de assinaturas.

    Declaração

    Swift

    public var count: Int { get }
  • Executa de forma síncrona qualquer transação (adicionar/remover/atualizar) no conjunto de assinaturas dentro do bloco.

    Declaração

    Swift

    public func update(_ block: (() -> Void), onComplete: (@Sendable (Error?) -> Void)? = nil)

    Parâmetros

    block

    O bloco contendo a transação de assinaturas a serem executadas.

    onComplete

    O bloco invocava a sincronização de subscrições no servidor. Caso contrário, um Errordescrevendo o que deu errado será retornado pelo bloco

  • Retorna o estado atual do conjunto de assinaturas.

    Declaração

    Swift

    public var state: SyncSubscriptionState { get }
  • Retorna uma assinatura pelo nome especificado.

    Declaração

    Swift

    public func first(named: String) -> SyncSubscription?

    Parâmetros

    named

    O nome da assinatura que procura.

    Valor de retorno

    Uma assinatura para o nome fornecido.

  • Retorna uma assinatura pela query especificada.

    Declaração

    Swift

    public func first<T>(ofType type: T.Type, where query: (Query<T>) -> Query<Bool>) -> SyncSubscription? where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser query.

    where

    Um construtor de query que produz uma assinatura que pode ser usada para pesquisar a assinatura por query e/ou nome.

    Valor de retorno

    Um query builder que produz uma assinatura que pode ser usada para pesquisar a assinatura.

  • Retorna uma assinatura pela query especificada.

    Declaração

    Swift

    public func first<T>(ofType type: T.Type, where predicateFormat: String, _ args: Any...) -> SyncSubscription? where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser query.

    where

    Um construtor de query que produz uma assinatura que pode ser usada para pesquisar a assinatura por query e/ou nome.

    Valor de retorno

    Um query builder que produz uma assinatura que pode ser usada para pesquisar a assinatura.

  • Retorna uma assinatura pela query especificada.

    Declaração

    Swift

    public func first<T>(ofType type: T.Type, where predicate: NSPredicate) -> SyncSubscription? where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser query.

    where

    Um construtor de query que produz uma assinatura que pode ser usada para pesquisar a assinatura por query e/ou nome.

    Valor de retorno

    Um query builder que produz uma assinatura que pode ser usada para pesquisar a assinatura.

  • Anexa uma ou várias assinaturas ao conjunto de assinaturas.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func append<T>(_ subscriptions: QuerySubscription<T>...) where T : RealmSwiftObject

    Parâmetros

    subscriptions

    As assinaturas a serem adicionadas ao conjunto de assinaturas.

  • Remove uma assinatura com a query especificada.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func remove<T>(ofType type: T.Type, _ query: @escaping (Query<T>) -> Query<Bool>) where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser removido.

    to

    Uma query para que a assinatura seja removida do conjunto de assinaturas.

  • Remove uma assinatura com a query especificada.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func remove<T>(ofType type: T.Type, where predicateFormat: String, _ args: Any...) where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser removido.

    predicateFormat

    Uma string de formato de predicado, opcionalmente seguida por um número variável de argumentos, que será usada para identificar a assinatura a ser removida.

  • Remove uma assinatura com a query especificada.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func remove<T>(ofType type: T.Type, where predicate: NSPredicate) where T : RealmSwiftObject

    Parâmetros

    type

    O tipo do objeto a ser removido.

    predicate

    O predicado que será usado para identificar a assinatura a ser removida.

  • Remove uma ou várias assinaturas do conjunto de assinaturas.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func remove(_ subscriptions: SyncSubscription...)

    Parâmetros

    subscription

    A assinatura a ser removida do conjunto de assinaturas.

  • Remove uma assinatura com o nome especificado do conjunto de assinaturas.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func remove(named: String)

    Parâmetros

    named

    O nome da assinatura a ser removida do conjunto de assinaturas.

  • Remove todas as assinaturas do conjunto de assinaturas.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Aviso

    A remoção de todas as assinaturas resultará em um erro se nenhuma nova assinatura for adicionada. O servidor deve reconhecer pelo menos uma assinatura.

    Declaração

    Swift

    public func removeAll(unnamedOnly: Bool = false)

    Parâmetros

    unnamedOnly

    Se verdadeiro, somente assinaturas sem nome serão removidas.

  • Remove zero ou nenhuma assinatura do tipo fornecido do conjunto de assinaturas.

    Aviso

    Este método só pode ser chamado durante um bloco de assinatura de gravação.

    Declaração

    Swift

    public func removeAll<T>(ofType type: T.Type) where T : RealmSwiftObject

    Parâmetros

    type

    O tipo dos objetos a serem removidos.

Recuperação de assinaturas

Suporte a sequências

  • Retorna um SyncSubscriptionSetIterator que produz elementos sucessivos na collection de assinaturas.

    Declaração

    Swift

    public func makeIterator() -> SyncSubscriptionSetIterator
  • update(_:) Assíncrono

    Cria e confirma uma transação, atualizando o conjunto de assinaturas, isso continuará quando o servidor reconhecer e todos os dados associados a esta collection de assinaturas forem sincronizados.

    Lança

    Um NSError se o estado do conjunto de assinaturas mudar para um estado de erro ou se houver um erro ao confirmar alterações nas assinaturas.

    Declaração

    Swift

    @MainActor
    public func update(_ block: (() -> Void)) async throws

    Parâmetros

    block

    O bloco contendo a transação de assinaturas a serem executadas.

  • Cria e confirma uma transação, atualizando o conjunto de assinaturas, isso retornará o sucesso quando o servidor reconhecer e todos os dados associados a esta collection de assinaturas estiverem sincronizados.

    Declaração

    Swift

    public func updateSubscriptions(_ block: @escaping (() -> Void)) -> Future<Void, Error>

    Parâmetros

    block

    O bloco contendo a transação de assinaturas a serem executadas.

    Valor de retorno

    Um editor que eventualmente retorna Result.success ou Error.