RLMSyncSubscriptionSet

Objective-C

@interface RLMSyncSubscriptionSet : NSObject <NSFastEnumeration>

Swift

@_nonSendable(_assumed) class RLMSyncSubscriptionSet : NSObject, NSFastEnumeration

RLMSyncSubscriptionSet é uma collection de RLMSyncSubscriptions. Este é o ponto de entrada para adicionar e remover RLMSyncSubscriptions.

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

    Declaração

    Objective-C

    @property (readonly) NSUInteger count;

    Swift

    var count: UInt { get }
  • Obtém o erro associado ao conjunto de assinaturas. Não será nulo caso o estado atual do conjunto de assinaturas seja RLMSyncSubscriptionStateError.

    Declaração

    Objective-C

    @property (nonatomic, readonly, nullable) NSError *error;

    Swift

    var error: (any Error)? { get }
  • Obtém o estado associado ao conjunto de assinatura .

    Declaração

    Objective-C

    @property (nonatomic, readonly) RLMSyncSubscriptionState state;

    Swift

    var state: RLMSyncSubscriptionState { get }

Assinaturas de atualizações em lote

  • Executa de forma síncrona quaisquer transações (adicionar/remover/atualizar) ao conjunto de assinatura dentro do bloco, isso não esperará que o servidor reconheça e veja todos os dados associados a essa coleção de assinaturas e retornará após confirmar as transações de assinatura .

    Declaração

    Objective-C

    - (void)update:(nonnull void (^)(void))block;

    Swift

    func update(_ block: () -> Void)

    Parâmetros

    block

    O bloco que contém ações a serem executadas no conjunto de assinatura .

  • Executa de forma síncrona quaisquer transações (adicionar/remover/atualizar) ao conjunto de assinatura dentro do bloco. O bloco onComplete é executado após aguardar que os dados associados sejam baixados do servidor.

    Declaração

    Objective-C

    - (void)update:(nonnull void (^)(void))block
        onComplete:(nullable void (^)(NSError *_Nullable))onComplete;

    Swift

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

    Parâmetros

    block

    O bloco que contém ações a serem executadas no conjunto de assinatura .

    onComplete

    Um bloco que é chamado após a sincronização de dados do servidor. O bloco será passado nil se a atualização for bem-sucedida e um erro descrevendo o problema de outra forma.

  • Executa de forma síncrona quaisquer transações (adicionar/remover/atualizar) ao conjunto de assinatura dentro do bloco. O bloco onComplete é executado após aguardar que os dados associados sejam baixados do servidor.

    Declaração

    Objective-C

    - (void)update:(nonnull void (^)(void))block
             queue:(nullable dispatch_queue_t)queue
        onComplete:(nonnull void (^)(NSError *_Nonnull))onComplete;

    Swift

    @_unsafeInheritExecutor func update(_ block: () -> Void, queue: dispatch_queue_t?, onComplete: @escaping (any Error) -> Void)

    Parâmetros

    block

    O bloco que contém ações a serem executadas no conjunto de assinatura .

    queue

    A fila em série para a qual entregar notificações.

    onComplete

    Um bloco que é chamado após a sincronização de dados do servidor. O bloco será passado nil se a atualização for bem-sucedida e um erro descrevendo o problema de outra forma.

Encontrar assinatura

  • Encontra uma assinatura pelo nome especificado.

    Declaração

    Objective-C

    - (nullable RLMSyncSubscription *)subscriptionWithName:(nonnull NSString *)name;

    Swift

    func subscription(withName name: String) -> RLMSyncSubscription?

    Parâmetros

    name

    O nome usado para identificar a assinatura.

    Valor de retorno

    Uma assinatura para o nome fornecido.

  • Localiza uma assinatura pela consulta para o nome da classe de objeto especificado.

    Declaração

    Objective-C

    - (nullable RLMSyncSubscription *)
        subscriptionWithClassName:(nonnull NSString *)objectClassName
                            where:(nonnull NSString *)predicateFormat, ...;

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicateFormat

    Uma string de formato de predicado, opcionalmente seguida por um número variável de argumentos.

    Valor de retorno

    Uma assinatura para a query fornecida..

  • Localiza uma assinatura pela consulta para o nome da classe de objeto especificado.

    Declaração

    Objective-C

    - (nullable RLMSyncSubscription *)
        subscriptionWithClassName:(nonnull NSString *)objectClassName
                        predicate:(nonnull NSPredicate *)predicate;

    Swift

    func subscription(withClassName objectClassName: String, predicate: NSPredicate) -> RLMSyncSubscription?

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicate

    O predicado usado para filtrar os objetos no servidor.

    Valor de retorno

    Uma assinatura para a query fornecida..

Adicionar uma assinatura

  • Adiciona uma nova assinatura ao conjunto de assinatura que será enviada ao servidor quando confirmada no final de um bloco de assinatura de gravação.

    Aviso

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

    Declaração

    Objective-C

    - (void)addSubscriptionWithClassName:(nonnull NSString *)objectClassName
                                   where:(nonnull NSString *)predicateFormat, ...;

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicateFormat

    Uma string de formato de predicado, opcionalmente seguida por um número variável de argumentos.

  • Adiciona uma nova assinatura ao conjunto de assinatura que será enviada ao servidor quando confirmada no final de um bloco de assinatura de gravação.

    Aviso

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

    Declaração

    Objective-C

    - (void)addSubscriptionWithClassName:(nonnull NSString *)objectClassName
                        subscriptionName:(nonnull NSString *)name
                                   where:(nonnull NSString *)predicateFormat, ...;

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    name

    O nome usado para identificar a assinatura.

    predicateFormat

    Uma string de formato de predicado, opcionalmente seguida por um número variável de argumentos.

  • Adiciona uma nova assinatura ao conjunto de assinatura que será enviada ao servidor quando confirmada no final de um bloco de assinatura de gravação.

    Aviso

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

    Declaração

    Objective-C

    - (void)addSubscriptionWithClassName:(nonnull NSString *)objectClassName
                               predicate:(nonnull NSPredicate *)predicate;

    Swift

    func addSubscription(withClassName objectClassName: String, predicate: NSPredicate)

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicate

    O predicado que define a query para a assinatura.

  • Adiciona uma nova assinatura ao conjunto de assinatura que será enviada ao servidor quando confirmada no final de um bloco de assinatura de gravação.

    Aviso

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

    Declaração

    Objective-C

    - (void)addSubscriptionWithClassName:(nonnull NSString *)objectClassName
                        subscriptionName:(nullable NSString *)name
                               predicate:(nonnull NSPredicate *)predicate;

    Swift

    func addSubscription(withClassName objectClassName: String, subscriptionName name: String?, predicate: NSPredicate)

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    name

    O nome usado para identificar a assinatura.

    predicate

    O predicado que define a query para a assinatura.

Remover assinatura

  • 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

    Objective-C

    - (void)removeSubscriptionWithName:(nonnull NSString *)name;

    Swift

    func removeSubscription(withName name: String)

    Parâmetros

    name

    O nome usado para identificar a assinatura.

  • Remove uma assinatura com a query especificada para a classe de objeto do conjunto de assinaturas.

    Aviso

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

    Declaração

    Objective-C

    - (void)removeSubscriptionWithClassName:(nonnull NSString *)objectClassName
                                      where:(nonnull NSString *)predicateFormat,
                                            ...;

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicateFormat

    Uma string de formato de predicado, opcionalmente seguida por um número variável de argumentos.

  • Remove uma assinatura com a query especificada para a classe de objeto do conjunto de assinaturas.

    Aviso

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

    Declaração

    Objective-C

    - (void)removeSubscriptionWithClassName:(nonnull NSString *)objectClassName
                                  predicate:(nonnull NSPredicate *)predicate;

    Swift

    func removeSubscription(withClassName objectClassName: String, predicate: NSPredicate)

    Parâmetros

    objectClassName

    O nome da classe de modelo a ser consultada.

    predicate

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

  • Remove a assinatura do conjunto de assinatura .

    Aviso

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

    Declaração

    Objective-C

    - (void)removeSubscription:(nonnull RLMSyncSubscription *)subscription;

    Swift

    func remove(_ subscription: RLMSyncSubscription)

    Parâmetros

    subscription

    Uma instância da assinatura a ser removida.

Remover subscrições

  • 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

    Objective-C

    - (void)removeAllSubscriptions;

    Swift

    func removeAllSubscriptions()
  • Remove todas as assinaturas sem nome do conjunto de assinatura .

    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

    Objective-C

    - (void)removeAllUnnamedSubscriptions;

    Swift

    func removeAllUnnamedSubscriptions()
  • Remove todas as assinatura com o nome de classe especificado.

    Aviso

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

    Declaração

    Objective-C

    - (void)removeAllSubscriptionsWithClassName:(nonnull NSString *)className;

    Swift

    func removeAllSubscriptions(withClassName className: String)

    Parâmetros

    className

    O nome da classe de modelo a ser consultada.

Coleção SubscriptionSet

Subscrito

  • Retorna a assinatura no index fornecido.

    Declaração

    Objective-C

    - (nonnull id)objectAtIndexedSubscript:(NSUInteger)index;

    Swift

    subscript(index: UInt) -> Any { get }

    Parâmetros

    index

    O índice.

    Valor de retorno

    Uma assinatura para o índice fornecido no conjunto de assinaturas.