RMSyncSubscriptionSet クラス参照

count
サブスクライブセット内のサブスクライブの数。
宣言
Objective-C

@property (readonly) NSUInteger count;
Swift

var count: UInt { get }
Githubでの表示
error
サブスクライブセットに関連付けられているエラーを取得します。サブスクリプションセットの現在の状態がRLMSyncSubscriptionStateErrorの場合、これは nil 以外になります。
宣言
Objective-C

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

var error: (any Error)? { get }
Githubでの表示
state
サブスクライブセットに関連付けられている状態を取得します。
宣言
Objective-C

@property (nonatomic, readonly) RLMSyncSubscriptionState state;
Swift

var state: RLMSyncSubscriptionState { get }
Githubでの表示

バッチ更新サブスクライブ


                    
                    
                    -update:

ブロック内のサブスクリプションセットに対するすべてのトランザクション（追加/削除/アップデート）を同期的に実行します。これは、サーバーがこのサブスクリプションのコレクションに関連付けられているすべてのデータを確認して表示するのを待たずに、サブスクライブトランザクションをコミットした後に返します。

宣言

Objective-C

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

Swift

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

パラメーター


                                block

サブスクリプションセットに対して実行するアクションを含むブロック。

Githubでの表示


                    
                    
                    -update:onComplete:

ブロック内のサブスクリプションセットへのトランザクション（追加/削除/アップデート）を同期的に実行します。 onCompleteブロックは、関連データがサーバーからダウンロードされるのを待った後に実行されます。

宣言

Objective-C

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

Swift

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

パラメーター

`block`	サブスクリプションセットに対して実行するアクションを含むブロック。
`onComplete`	サーバーからのデータの同期時に呼び出されるブロック。アップデートが成功した場合はブロックは`nil`と、それ以外の場合は問題を説明するエラーが渡されます。

Githubでの表示


                    
                    
                    -update:queue:onComplete:

ブロック内のサブスクリプションセットへのトランザクション（追加/削除/アップデート）を同期的に実行します。 onCompleteブロックは、関連データがサーバーからダウンロードされるのを待った後に実行されます。

宣言

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)

パラメーター

`block`	サブスクリプションセットに対して実行するアクションを含むブロック。
`queue`	通知を送信するシリアルキュー。
`onComplete`	サーバーからのデータの同期時に呼び出されるブロック。アップデートが成功した場合はブロックは`nil`と、それ以外の場合は問題を説明するエラーが渡されます。

Githubでの表示

検索サブスクライブ


                    
                    
                    -subscriptionWithName:

指定した名前でサブスクライブを検索します。

宣言

Objective-C

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

Swift

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

パラメーター


                                name

サブスクリプションを識別するために使用される名前。

戻り値

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

Githubでの表示


                    
                    
                    -subscriptionWithClassName:where:

指定されたオブジェクトクラス名のクエリによってサブスクリプションを検索します。

宣言

Objective-C

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicateFormat`	述語形式の string 。オプションで、その後に変数の数の引数が続きます。

戻り値

指定されたクエリのサブスクライブ。

Githubでの表示


                    
                    
                    -subscriptionWithClassName:predicate:

指定されたオブジェクトクラス名のクエリによってサブスクリプションを検索します。

宣言

Objective-C

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

Swift

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicate`	サーバー上のオブジェクトをフィルタリングするために使用される述語。

戻り値

指定されたクエリのサブスクライブ。

Githubでの表示

サブスクリプションを追加する


                    
                    
                    -addSubscriptionWithClassName:where:

書込み (write) サブスクライブブロックの最後にコミットされるとサーバーに送信されるサブスクリプションセットに新しいサブスクリプションを追加します。

警告

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

宣言

Objective-C

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicateFormat`	述語形式の string 。オプションで、その後に変数の数の引数が続きます。

Githubでの表示


                    
                    
                    -addSubscriptionWithClassName:subscriptionName:where:

書込み (write) サブスクライブブロックの最後にコミットされるとサーバーに送信されるサブスクリプションセットに新しいサブスクリプションを追加します。

警告

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

宣言

Objective-C

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`name`	サブスクリプションを識別するために使用される名前。
`predicateFormat`	述語形式の string 。オプションで、その後に変数の数の引数が続きます。

Githubでの表示


                    
                    
                    -addSubscriptionWithClassName:predicate:

書込み (write) サブスクライブブロックの最後にコミットされるとサーバーに送信されるサブスクリプションセットに新しいサブスクリプションを追加します。

警告

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

宣言

Objective-C

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

Swift

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicate`	サブスクライブのクエリを定義する述語。

Githubでの表示


                    
                    
                    -addSubscriptionWithClassName:subscriptionName:predicate:

書込み (write) サブスクライブブロックの最後にコミットされるとサーバーに送信されるサブスクリプションセットに新しいサブスクリプションを追加します。

警告

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

宣言

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)

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`name`	サブスクリプションを識別するために使用される名前。
`predicate`	サブスクライブのクエリを定義する述語。

Githubでの表示

サブスクリプションの削除


                    
                    
                    -removeSubscriptionWithName:

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

警告

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

宣言

Objective-C

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

Swift

func removeSubscription(withName name: String)

パラメーター


                                name

サブスクリプションを識別するために使用される名前。

Githubでの表示


                    
                    
                    -removeSubscriptionWithClassName:where:

オブジェクトクラスの指定されたクエリを持つサブスクライブをサブスクライブセットから削除します。

警告

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

宣言

Objective-C

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicateFormat`	述語形式の string 。オプションで、その後に変数の数の引数が続きます。

Githubでの表示


                    
                    
                    -removeSubscriptionWithClassName:predicate:

オブジェクトクラスの指定されたクエリを持つサブスクライブをサブスクライブセットから削除します。

警告

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

宣言

Objective-C

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

Swift

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

パラメーター

`objectClassName`	クエリされるモデルクラスのクラス名。
`predicate`	削除するサブスクリプションを識別するために使用される述語。

Githubでの表示


                    
                    
                    -removeSubscription:

サブスクライブをサブスクライブセットから削除します。

警告

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

宣言

Objective-C

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

Swift

func remove(_ subscription: RLMSyncSubscription)

パラメーター


                                subscription

削除するサブスクライブのインスタンス。

Githubでの表示

サブスクリプションの削除

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

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

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

- (void)removeAllSubscriptions;
Swift

func removeAllSubscriptions()
Githubでの表示
-removeAllUnnamedSubscriptions
サブスクリプションセットから名前のないすべてのサブスクライブを削除します。

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

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

- (void)removeAllUnnamedSubscriptions;
Swift

func removeAllUnnamedSubscriptions()
Githubでの表示


                    
                    
                    -removeAllSubscriptionsWithClassName:

指定されたクラス名を持つすべてのサブスクライブを削除します。

警告

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

宣言

Objective-C

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

Swift

func removeAllSubscriptions(withClassName className: String)

パラメーター


                                className

クエリされるモデルクラスのクラス名。

Githubでの表示

SubscriptionSet コレクション


                    
                    
                    -objectAtIndex:

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

宣言

Objective-C

- (nullable RLMSyncSubscription *)objectAtIndex:(NSUInteger)index;

Swift

func object(at index: UInt) -> RLMSyncSubscription?

パラメーター


                                index

インデックス。

戻り値

サブスクリプションセット内の指定されたインデックスのサブスクライブ。

Githubでの表示

-firstObject
サブスクライブセットリスト内の最初のオブジェクトを返します。サブスクライブが空の場合はnilを返します。
宣言
Objective-C

- (nullable RLMSyncSubscription *)firstObject;
Swift

func firstObject() -> RLMSyncSubscription?
戻り値

サブスクライブ。

Githubでの表示
-lastObject
サブスクライブセット内の最後のオブジェクトを返します。サブスクライブが空の場合はnilを返します。
宣言
Objective-C

- (nullable RLMSyncSubscription *)lastObject;
Swift

func lastObject() -> RLMSyncSubscription?
戻り値

サブスクライブ。

Githubでの表示

サブスクライブ


                    
                    
                    -objectAtIndexedSubscript:

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

宣言

Objective-C

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

Swift

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

パラメーター


                                index

インデックス。

戻り値

サブスクリプションセット内の指定されたインデックスのサブスクライブ。

Githubでの表示