Class Realm

Properties

$addr activeSubscriptionSet auditContext autoRefresh canDeliverNotifications config currentTransactionVersion isClosed isEmpty isFrozen isInMigration isInTransaction latestSubscriptionSet numberOfVersions readTransactionVersion scheduler schema schemaVersion syncSession

Methods

$resetSharedPtr beginTransaction cancelTransaction close commitTransaction compact convert createKeyPathArray duplicate enableWaitForChange freeze invalidate lastSeenTransactionVersion notify readGroup refresh setAutoRefresh updateSchema verifyInWrite verifyNotificationsAvailable verifyNotificationsAvailableMaybeThrow verifyOpen verifyThread waitForChange waitForChangeRelease writeCopy getSchemaVersion getSharedRealm getSynchronizedRealm

Properties

Readonly $addr

$addr: number

Readonly activeSubscriptionSet

activeSubscriptionSet: SyncSubscriptionSet

Deprecated

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

Readonly auditContext

auditContext: null | AuditInterface

Deprecated

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

Readonly autoRefresh

autoRefresh: boolean

Deprecated

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

Readonly canDeliverNotifications

canDeliverNotifications: boolean

Deprecated

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

Readonly config

config: Readonly<RealmConfig>

Readonly currentTransactionVersion

currentTransactionVersion: undefined | VersionId

Deprecated

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

Readonly isClosed

isClosed: boolean

Readonly isEmpty

isEmpty: boolean

Readonly isFrozen

isFrozen: boolean

Deprecated

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

Readonly isInMigration

isInMigration: boolean

Readonly isInTransaction

isInTransaction: boolean

Readonly latestSubscriptionSet

latestSubscriptionSet: SyncSubscriptionSet

Readonly numberOfVersions

numberOfVersions: Int64Type

Deprecated

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

Readonly readTransactionVersion

readTransactionVersion: VersionId

Deprecated

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

Readonly scheduler

scheduler: Scheduler

Deprecated

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

Readonly schema

schema: readonly ObjectSchema[]

Readonly schemaVersion

schemaVersion: Int64Type

Readonly syncSession

syncSession: null | SyncSession

Methods

$resetSharedPtr

  • $resetSharedPtr(): void

  • Returns void

beginTransaction

  • beginTransaction(): void

  • Returns void

cancelTransaction

  • cancelTransaction(): void

  • Returns void

close

  • close(): void

  • Returns void

commitTransaction

  • commitTransaction(): void

  • Returns void

compact

  • compact(): boolean

  • Returns boolean

convert

  • convert(config): void

  • Parameters

    Returns void

createKeyPathArray

  • createKeyPathArray(table_name, key_paths): [TableKey, ColKey][][]

  • Parameters

    • table_name: string
    • key_paths: readonly string[]

    Returns [TableKey, ColKey][][]

duplicate

  • duplicate(): Transaction

  • Returns Transaction

    Deprecated

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

enableWaitForChange

  • enableWaitForChange(): void

  • Returns void

    Deprecated

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

freeze

  • freeze(): Realm

  • Returns Realm

    Deprecated

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

invalidate

  • invalidate(): void

  • Returns void

    Deprecated

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

lastSeenTransactionVersion

  • lastSeenTransactionVersion(): Int64Type

  • Returns Int64Type

    Deprecated

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

notify

  • notify(): void

  • Returns void

    Deprecated

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

readGroup

  • readGroup(): Group

  • Returns Group

    Deprecated

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

refresh

  • refresh(): boolean

  • Returns boolean

    Deprecated

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

setAutoRefresh

  • setAutoRefresh(auto_refresh): void

  • Parameters

    • auto_refresh: boolean

    Returns void

    Deprecated

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

updateSchema

  • updateSchema(schema, version, migration_function, initialization_function, in_transaction): void

  • Parameters

    • schema: ObjectSchema_Relaxed[]
    • version: Int64Type
    • migration_function: null | ((old_realm, new_realm) => void)
    • initialization_function: null | ((realm) => void)
    • in_transaction: boolean

    Returns void

verifyInWrite

  • verifyInWrite(): void

  • Returns void

    Deprecated

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

verifyNotificationsAvailable

  • verifyNotificationsAvailable(): void

  • Returns void

    Deprecated

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

verifyNotificationsAvailableMaybeThrow

  • verifyNotificationsAvailableMaybeThrow(throw_on_error): void

  • Parameters

    • throw_on_error: boolean

    Returns void

    Deprecated

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

verifyOpen

  • verifyOpen(): void

  • Returns void

verifyThread

  • verifyThread(): void

  • Returns void

    Deprecated

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

waitForChange

  • waitForChange(): boolean

  • Returns boolean

    Deprecated

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

waitForChangeRelease

  • waitForChangeRelease(): void

  • Returns void

    Deprecated

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

writeCopy

  • writeCopy(): ArrayBuffer

  • Returns ArrayBuffer

    Deprecated

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

Static getSchemaVersion

Static getSharedRealm

Static getSynchronizedRealm

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc