SyncSubscriptionSet

@frozen
public struct SyncSubscriptionSet
extension SyncSubscriptionSet: Sequence

SyncSubscriptionSetSyncSubscriptionのコレクションです。 これは、 SyncSubscriptionを追加および削除するためのエントリ ポイントです。

初期化子

  • サブスクライブセット内のサブスクライブの数。

    宣言

    Swift

    public var count: Int { get }
  • ブロック内のサブスクリプションセットへのトランザクション(追加/削除/アップデート)を同期的に実行します。

    宣言

    Swift

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

    パラメーター

    block

    実行するサブスクライブ トランザクションを含むブロック。

    onComplete

    サーバーへのサブスクリプションの同期時に呼び出されるブロック。 それ以外の場合、何が起こるかを説明するErrorがブロックによって返されます

  • サブスクライブ セットの現在の状態を返します。

    宣言

    Swift

    public var state: SyncSubscriptionState { get }
  • 指定された名前のサブスクライブを返します。

    宣言

    Swift

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

    パラメーター

    named

    を検索するサブスクライブの名前。

    戻り値

    指定された名前のサブスクライブ。

  • 指定されたクエリによってサブスクライブを返します。

    宣言

    Swift

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

    パラメーター

    type

    クエリされるオブジェクトの型。

    where

    クエリや名前でサブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

    戻り値

    サブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

  • 指定されたクエリによってサブスクライブを返します。

    宣言

    Swift

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

    パラメーター

    type

    クエリされるオブジェクトの型。

    where

    クエリや名前でサブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

    戻り値

    サブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

  • 指定されたクエリによってサブスクライブを返します。

    宣言

    Swift

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

    パラメーター

    type

    クエリされるオブジェクトの型。

    where

    クエリや名前でサブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

    戻り値

    サブスクリプションを検索するために使用できるサブスクライブを生成するクエリ ビルダ。

  • 1 つまたは複数のサブスクライブをサブスクライブセットに追加します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    subscriptions

    サブスクライブセットに追加するサブスクライブ。

  • 指定されたクエリでサブスクライブを削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    type

    削除するオブジェクトのタイプ。

    to

    サブスクリプションをサブスクリプションセットから削除するためのクエリ。

  • 指定されたクエリでサブスクライブを削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    type

    削除するオブジェクトのタイプ。

    predicateFormat

    述語形式の string。オプションとして、削除するサブスクリプションを識別するために使用される変数の引数が続きます。

  • 指定されたクエリでサブスクライブを削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    type

    削除するオブジェクトのタイプ。

    predicate

    削除するサブスクリプションを識別するために使用される述語。

  • サブスクリプションセットから 1 つまたは複数のサブスクライブを削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    subscription

    サブスクライブセットから削除するサブスクライブ。

  • 指定された名前のサブスクライブをサブスクライブセットから削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

    public func remove(named: String)

    パラメーター

    named

    サブスクリプションセットから削除するサブスクライブの名前。

  • サブスクリプションセットからすべてのサブスクライブを削除します。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    警告

    すべてのサブスクライブを削除すると、新しいサブスクリプションが追加されていない場合は、 エラーが発生します。 サーバーは少なくとも 1 つのサブスクライブを確認する必要があります。

    宣言

    Swift

    public func removeAll(unnamedOnly: Bool = false)

    パラメーター

    unnamedOnly

    true の場合、名前のないサブスクリプションのみが削除されます。

  • 指定されたタイプのサブスクライブをサブスクライブセットからゼロまたはゼロにします。

    警告

    このメソッドは、書込み (write) サブスクライブ ブロック中にのみ呼び出されます。

    宣言

    Swift

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

    パラメーター

    type

    削除されるオブジェクトのタイプ。

サブスクリプションの取得

  • 指定されたpositionのサブスクライブを返します。

    宣言

    Swift

    public subscript(position: Int) -> SyncSubscription? { get }

    パラメーター

    position

    結果サブスクライブのインデックス。

  • SyncSubscription リストの最初のオブジェクトを返します。サブスクライブが空の場合はnilを返します。

    宣言

    Swift

    public var first: SyncSubscription? { get }
  • SyncSubscription リスト内の最後のオブジェクトを返します。サブスクライブが空の場合はnilを返します。

    宣言

    Swift

    public var last: SyncSubscription? { get }

シーケンス サポート

  • サブスクライブ コレクション内の連続する要素を生成するSyncSubscriptionSetIteratorを返します。

    宣言

    Swift

    public func makeIterator() -> SyncSubscriptionSetIterator
  • update(_:) 非同期

    トランザクションを作成してコミットし、サブスクリプションセットを更新します。これは、サーバーが確認応答し、このサブスクリプションのコレクションに関連するすべてのデータを同期しても継続されます。

    スロー

    サブスクリプション セットの状態がエラー状態に変化した場合、またはサブスクライブへの変更をコミットするときに と エラーが発生した場合は、 NSError

    宣言

    Swift

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

    パラメーター

    block

    実行するサブスクライブ トランザクションを含むブロック。

  • トランザクションを作成してコミットし、サブスクリプションセットを更新します。これは、サーバーがこのサブスクリプションのコレクションに関連するすべてのデータを確認し、同期すると成功を返します。

    宣言

    Swift

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

    パラメーター

    block

    実行するサブスクライブ トランザクションを含むブロック。

    戻り値

    最終的にResult.successまたはErrorを返す出版社。