Class List

Hierarchy (view full)

Collection
- List

Properties

`Readonly` isFrozen

isFrozen: boolean

Deprecated

Add is_frozen to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` isValid

isValid: boolean

`Readonly` objectSchema

objectSchema: Readonly<ObjectSchema>

`Readonly` parentColumnKey

parentColumnKey: ColKey

Deprecated

Add get_parent_column_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` parentObjectKey

parentObjectKey: ObjKey

Deprecated

Add get_parent_object_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` parentTableKey

parentTableKey: TableKey

Deprecated

Add get_parent_table_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` realm

realm: Realm

Deprecated

Add get_realm to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` size

size: number

`Readonly` type

type: PropertyType

Deprecated

Add get_type to your opt-in list (under classes/Collection/methods/) to use this.

Methods

addNotificationCallback

addNotificationCallback(cb, keyPaths): NotificationToken
Parameters
- cb: ((changes) => void)
  - - (changes): void
    - Parameters
      changes: Readonly<CollectionChangeSet>
      Returns void
- keyPaths: undefined | [TableKey, ColKey][][]
Returns NotificationToken
Deprecated
Add add_notification_callback to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.addNotificationCallback
- Defined in packages/realm/binding/generated/native.d.ts:982

asResults

asResults(): Results
Returns Results
Inherited from Collection.asResults
- Defined in packages/realm/binding/generated/native.d.ts:974

average

average(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add average to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1031

averageOf

averageOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add average_of to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1033

deleteAll

deleteAll(): void
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1013

deleteAt

deleteAt(ndx): void
Parameters
- ndx: number
Returns void
Deprecated
Add delete_at to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1012

filter

filter(q): Results
Parameters
- q: Query
Returns Results
Deprecated
Add filter to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1019

findAny

findAny(value): number
Parameters
- value: MixedArg
Returns number
Deprecated
Add find_any to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.findAny
- Defined in packages/realm/binding/generated/native.d.ts:969

freeze

freeze(frozen_realm): List
Parameters
- frozen_realm: Readonly<Realm>
Returns List
Deprecated
Add freeze to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1021

get

get(ndx): Obj
Parameters
- ndx: number
Returns Obj
Deprecated
Add get to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1006

getAny

getAny(ndx): Mixed
Parameters
- ndx: number
Returns Mixed
Inherited from Collection.getAny
- Defined in packages/realm/binding/generated/native.d.ts:967

insertAny

insertAny(list_ndx, value): void
Parameters
- list_ndx: number
- value: MixedArg
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1014

insertEmbedded

insertEmbedded(ndx): Obj
Parameters
- ndx: number
Returns Obj
- Defined in packages/realm/binding/generated/native.d.ts:1015

max

max(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add max to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1023

maxOf

maxOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add max_of to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1025

min

min(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add min to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1027

minOf

minOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add min_of to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1029

move

move(source_ndx, dest_ndx): void
Parameters
- source_ndx: number
- dest_ndx: number
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1007

remove

remove(ndx): void
Parameters
- ndx: number
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1008

removeAll

removeAll(): void
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1009

setAny

setAny(list_ndx, value): void
Parameters
- list_ndx: number
- value: MixedArg
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1016

setEmbedded

setEmbedded(list_ndx): Obj
Parameters
- list_ndx: number
Returns Obj
- Defined in packages/realm/binding/generated/native.d.ts:1017

snapshot

snapshot(): Results
Returns Results
Deprecated
Add snapshot to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.snapshot
- Defined in packages/realm/binding/generated/native.d.ts:976

sort

sort(order): Results
Parameters
- order: SortDescriptor
Returns Results
Deprecated
Add sort to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.sort
- Defined in packages/realm/binding/generated/native.d.ts:978

sortByName

sortByName(keyPaths): Results
Parameters
- keyPaths: readonly [string, boolean][]
Returns Results
Deprecated
Add sort_by_name to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.sortByName
- Defined in packages/realm/binding/generated/native.d.ts:980

sum

sum(): Mixed
Returns Mixed
Deprecated
Add sum to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1035

sumOf

sumOf(column): Mixed
Parameters
- column: ColKey
Returns Mixed
Deprecated
Add sum_of to your opt-in list (under classes/List/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1037

swap

swap(ndx1, ndx2): void
Parameters
- ndx1: number
- ndx2: number
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1010

verifyAttached

verifyAttached(): void
Returns void
Deprecated
Add verify_attached to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.verifyAttached
- Defined in packages/realm/binding/generated/native.d.ts:971

verifyInTransaction

verifyInTransaction(): void
Returns void
Deprecated
Add verify_in_transaction to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.verifyInTransaction
- Defined in packages/realm/binding/generated/native.d.ts:973

`Static` make

make(r, parent, col): List
Parameters
- r: Realm
- parent: Readonly<Obj>
- col: ColKey
Returns List
- Defined in packages/realm/binding/generated/native.d.ts:1038

Class List

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly isFrozen

Deprecated

Readonly isValid

Readonly objectSchema

Readonly parentColumnKey

Deprecated

Readonly parentObjectKey

Deprecated

Readonly parentTableKey

Deprecated

Readonly realm

Deprecated

Readonly size

Readonly type

Deprecated

Methods

addNotificationCallback

Parameters

cb: ((changes) => void)

Parameters

changes: Readonly<CollectionChangeSet>

Returns void

keyPaths: undefined | [TableKey, ColKey][][]

Returns NotificationToken

Deprecated

asResults

Returns Results

average

Returns undefined | Mixed

Deprecated

averageOf

Parameters

column: ColKey

Returns undefined | Mixed

Deprecated

deleteAll

Returns void

deleteAt

Parameters

ndx: number

Returns void

Deprecated

filter

Parameters

q: Query

Returns Results

Deprecated

findAny

Parameters

value: MixedArg

Returns number

Deprecated

freeze

Parameters

frozen_realm: Readonly<Realm>

Returns List

Deprecated

get

Parameters

ndx: number

Returns Obj

Deprecated

getAny

Parameters

ndx: number

Returns Mixed

insertAny

Parameters

list_ndx: number

value: MixedArg

Returns void

insertEmbedded

Parameters

ndx: number

`Readonly` isFrozen

`Readonly` isValid

`Readonly` objectSchema

`Readonly` parentColumnKey

`Readonly` parentObjectKey

`Readonly` parentTableKey

`Readonly` realm

`Readonly` size

`Readonly` type

`Static` make