LinkingObjects

@frozen
public struct LinkingObjects<Element> where Element : ObjectBase, Element : RealmCollectionValue
extension LinkingObjects: RealmSubscribable
extension LinkingObjects: RealmCollection

LinkingObjects é um tipo de contêiner de atualização automática. Representa zero ou mais objetos que estão vinculados ao objeto modelo de sua propriedade por meio de um relacionamento de propriedade.

LinkingObjects pode ser query com os mesmos predicados que List<Element> e Results<Element>.

LinkingObjects sempre reflete o estado atual do Realm na thread atual, inclusive durante transação de escrita na thread atual. A única exceção a isso é ao usar a enumeração for...in , que sempre enumerará sobre os objetos de vinculação que estavam presentes quando a enumeração for iniciada, mesmo que alguns deles sejam excluídos ou modificados para não serem mais vinculados ao objeto de destino durante a enumeração .

LinkingObjects só pode ser usado como uma propriedade em modelos Object . Propriedades deste tipo devem ser declaradas como let e não podem ser dynamic.

  • O tipo dos objetos representados pelos objetos de vinculação.

    Declaração

    Swift

    public typealias ElementType = Element

Propriedades

  • O Realm que gerencia os objetos de vinculação, ou nil se os objetos de vinculação não forem gerenciados.

    Declaração

    Swift

    public var realm: Realm? { get }
  • Indica se os objetos de vinculação não são mais válidos.

    Os objetos de vinculação tornam-se inválidos se invalidate() for chamado na instância realm que o contém.

    Um objeto de vinculação invalidado pode ser acessado, mas sempre estará vazio.

    Declaração

    Swift

    public var isInvalidated: Bool { get }
  • O número de objetos de vinculação.

    Declaração

    Swift

    public var count: Int { get }

Inicializadores

  • Cria uma instância de um LinkingObjects. Esse inicializador só deve ser chamado ao declarar uma propriedade em um modelo Realm.

    Declaração

    Swift

    public init(fromType _: Element.Type, property propertyName: String)

    Parâmetros

    type

    O tipo do objeto que possui a propriedade à qual os objetos de vinculação devem se referir.

    propertyName

    O nome da propriedade a que os objetos de vinculação devem se referir.

  • Uma descrição legível por humanos dos objetos representados pelos objetos vinculados.

    Declaração

    Swift

    public var description: String { get }

Recuperação de Índice

  • Retorna o índice de um objeto nos objetos de vinculação ou nil se o objeto não estiver presente.

    Declaração

    Swift

    public func index(of object: Element) -> Int?

    Parâmetros

    object

    O objeto cujo índice está sendo query.

  • Retorna o índice do primeiro objeto que corresponde ao predicado fornecido ou nil se nenhum objeto corresponder.

    Declaração

    Swift

    public func index(matching predicate: NSPredicate) -> Int?

    Parâmetros

    predicate

    O predicado com o qual filtrar os objetos.

Recuperação de objetos

  • Retorna o objeto no index fornecido.

    Declaração

    Swift

    public subscript(index: Int) -> Element { get }

    Parâmetros

    index

    O índice.

  • Retorna o primeiro objeto nos objetos de vinculação ou nil se os objetos de vinculação estiverem vazios.

    Declaração

    Swift

    public var first: Element? { get }
  • Retorna o último objeto nos objetos de vinculação ou nil se os objetos de vinculação estiverem vazios.

    Declaração

    Swift

    public var last: Element? { get }

KVC

  • Retorna um Array contendo os resultados de invocar valueForKey(_:) com key em cada um dos objetos de vinculação.

    Declaração

    Swift

    public func value(forKey key: String) -> Any?

    Parâmetros

    key

    O nome da propriedade cujos valores são desejados.

  • Retorna um Array contendo os resultados de invocar valueForKeyPath(_:) com keyPath em cada um dos objetos de vinculação.

    Declaração

    Swift

    public func value(forKeyPath keyPath: String) -> Any?

    Parâmetros

    keyPath

    O caminho da chave para a propriedade cujos valores são desejados.

  • Invoca setValue(_:forKey:) em cada um dos objetos de vinculação usando value e key especificados.

    Aviso

    Este método só pode ser chamado durante uma transação de escrita.

    Declaração

    Swift

    public func setValue(_ value: Any?, forKey key: String)

    Parâmetros

    value

    O valor para definir a propriedade.

    key

    O nome da propriedade cujo valor deve ser definido em cada objeto.

Filtragem

  • Retorna um Results contendo todos os objetos que correspondem ao predicado fornecido nos objetos de vinculação.

    Declaração

    Swift

    public func filter(_ predicate: NSPredicate) -> Results<Element>

    Parâmetros

    predicate

    O predicado com o qual filtrar os objetos.

Classificação

  • Retorna um Results contendo todos os objetos de link, exceto classificados.

    Os objetos são classificados com base nos valores do caminho de chave fornecido. Por exemplo, para classificar uma coleção de Student s do mais novo para o mais antigo com base em sua propriedade age , você pode chamar students.sorted(byKeyPath: "age", ascending: true) .

    Aviso

    As collection só podem ser classificadas por propriedade dos tipos booleano, Date, NSDate, ponto flutuante de precisão única e dupla, inteiro e string.

    Declaração

    Swift

    public func sorted(byKeyPath keyPath: String, ascending: Bool = true) -> Results<Element>

    Parâmetros

    keyPath

    O caminho da chave para classificar por.

    ascending

    A direção para classificar.

  • Retorna um Results contendo todos os objetos de link, exceto classificados.

    Aviso

    As collection só podem ser classificadas por propriedade dos tipos booleano, Date, NSDate, ponto flutuante de precisão única e dupla, inteiro e string.

    Declaração

    Swift

    public func sorted<S: Sequence>(by sortDescriptors: S) -> Results<Element>
        where S.Iterator.Element == SortDescriptor

    Parâmetros

    sortDescriptors

    Uma sequência de SortDescriptors para classificar.

Operações agregadas

  • Retorna o valor mínimo (mais baixo) de determinada propriedade entre todos os objetos de vinculação ou nil se os objetos de vinculação estiverem vazios.

    Aviso

    Somente uma propriedade cujo tipo esteja em conformidade com o protocolo MinMaxType pode ser especificada.

    Declaração

    Swift

    public func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parâmetros

    property

    O nome de uma propriedade cujo valor mínimo é desejado.

  • Retorna o valor máximo (mais alto) de determinada propriedade entre todos os objetos de vinculação ou nil se os objetos de vinculação estiverem vazios.

    Aviso

    Somente uma propriedade cujo tipo esteja em conformidade com o protocolo MinMaxType pode ser especificada.

    Declaração

    Swift

    public func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parâmetros

    property

    O nome de uma propriedade cujo valor mínimo é desejado.

  • Retorna a soma dos valores de uma determinada propriedade sobre todos os objetos de vinculação.

    Aviso

    Somente uma propriedade cujo tipo esteja em conformidade com o protocolo AddableType pode ser especificada.

    Declaração

    Swift

    public func sum<T>(ofProperty property: String) -> T where T : AddableType

    Parâmetros

    property

    O nome de uma propriedade cujos valores devem ser somados.

  • Retorna o valor médio de uma determinada propriedade sobre todos os objetos de vinculação, ou nil se os objetos de vinculação estiverem vazios.

    Aviso

    Somente o nome de uma propriedade cujo tipo esteja em conformidade com o protocolo AddableType pode ser especificado.

    Declaração

    Swift

    public func average<T>(ofProperty property: String) -> T? where T : AddableType

    Parâmetros

    property

    O nome de uma propriedade cujo valor médio deve ser calculado.

Notificações

  • Registra um bloco a ser chamado cada vez que a collection for alterada.

    O bloco será chamado de forma assíncrona com os resultados iniciais e, em seguida, chamado novamente após cada transação de gravação que altere qualquer um dos objetos da coleção ou quais objetos estão na coleção.

    O parâmetro change que é passado para o bloco reporta, na forma de índices dentro da collection, quais dos objetos foram adicionados, removidos ou modificados durante cada transação de escrita. Consulte a documentação do RealmCollectionChange para obter mais informações sobre as informações de alteração fornecidas e um exemplo de como usá-las para atualizar um UITableView .

    No momento em que o bloqueio for chamado, a coleção será totalmente avaliada e atualizada e, desde que você não execute uma transação de gravação na mesma thread ou chame explicitamente realm.refresh() , acessá-la nunca executará o bloqueio trabalho.

    Se nenhuma fila for fornecida, as notificações serão entregues por meio do loop de execução padrão e, portanto, não poderão ser entregues enquanto o loop de execução estiver bloqueado por outra atividade. Se uma fila for fornecida, as notificações serão entregues para essa fila. Quando as notificações não podem ser entregues instantaneamente, várias notificações podem ser agrupadas em uma única notificação. Isso pode incluir a notificação com a coleção inicial.

    Por exemplo, o código a seguir executa uma transação de escrita imediatamente após adicionar o bloqueio de notificação, para que não haja oportunidade para que a notificação inicial seja entregue primeiro. Como resultado, a notificação inicial refletirá o estado do Realm após a transação de escrita.

    let results = realm.objects(Dog.self)
    print("dogs.count: \(dogs?.count)") // => 0
    let token = dogs.observe { changes in
        switch changes {
        case .initial(let dogs):
            // Will print "dogs.count: 1"
            print("dogs.count: \(dogs.count)")
            break
        case .update:
            // Will not be hit in this example
            break
        case .error:
            break
        }
    }
    try! realm.write {
        let dog = Dog()
        dog.name = "Rex"
        person.dogs.append(dog)
    }
    // end of run loop execution context
    

    Você deve reter o token retornado pelo tempo que desejar que as atualizações sejam enviadas ao bloco. Para parar de receber atualizações, ligue para invalidate() no token.

    Aviso

    Este método não pode ser chamado durante uma transação de escrita, ou quando o Realm que o contém for somente leitura.

    Declaração

    Swift

    public func observe(on queue: DispatchQueue? = nil,
                        _ block: @escaping (RealmCollectionChange<LinkingObjects>) -> Void) -> NotificationToken

    Parâmetros

    queue

    A fila de despacho em série para receber a notificação. Se nil, as notificações são entregues ao thread atual.

    block

    O bloco a ser chamado sempre que ocorre uma alteração.

    Valor de retorno

    Um token que deve ser mantido pelo tempo que você quiser que as atualizações sejam entregues.

Objetos congelados

  • Retorna se esta coleção estiver congelada.

    Declaração

    Swift

    public var isFrozen: Bool { get }
  • Retorna um snapshot congelado (imutável) desta collection.

    A cópia congelada é uma coleção imutável que contém os mesmos dados que esta coleção contém atualmente, mas não será atualizada quando forem feitas gravações no Realm que a contém. Ao contrário das collections ativas, as collections congeladas podem ser acessadas de qualquer thread.

    Aviso

    Este método não pode ser chamado durante uma transação de escrita, ou quando o Realm que o contém for somente leitura.

    Aviso

    Manter uma collection congelada por um longo período enquanto executa transação de escrita no Realm pode fazer com que o Arquivo de Realm cresça para tamanhos grandes. Consulte Realm.Configuration.maximumNumberOfActiveVersions para obter mais informações.

    Declaração

    Swift

    public func freeze() -> LinkingObjects
  • Retorna uma versão ativa dessa collection congelada.

    Esse método resolve uma referência a uma cópia ativa da mesma collection congelada. Se for chamado em uma coleção ativa, retornará a si mesmo.

    Declaração

    Swift

    public func thaw() -> LinkingObjects<Element>?

LinkingObjects

  • Uma editora que emite um vazio toda vez que a collection muda.

    Apesar do nome, isso na verdade é emitido após a mudança da collection.

    Declaração

    Swift

    public var objectWillChange: RealmPublishers.WillChange<LinkingObjects> { get }

Suporte a sequências

Suporte a collections

  • A posição do primeiro elemento em uma coleção não vazia. Idêntico ao endIndex em uma coleta vazia.

    Declaração

    Swift

    public var startIndex: Int { get }
  • A posição "além do final" da collection. endIndex não é um argumento válido para subscrito e está sempre acessível a partir de startIndex por zero ou mais aplicações de sucessor ().

    Declaração

    Swift

    public var endIndex: Int { get }
  • Declaração

    Swift

    public func index(after: Int) -> Int
  • Declaração

    Swift

    public func index(before: Int) -> Int