클래스: SubscriptionSet

확장

Realm.App.Sync.BaseSubscriptionSet

오류

읽기 전용

state 가 Realm.App.Sync.SubscriptionsState.Error 인 경우, SubscriptionSet가 오류 상태인 이유를 나타내는 string 을 반환합니다. 오류가 없으면 null 가 반환됩니다.

유형:

string or null

isEmpty

읽기 전용

세트에 구독이 없으면 true 를 반환하고, 그렇지 않으면 false 을 반환합니다.

유형:

boolean

분량

읽기 전용

세트의 구독 수입니다.

유형:

number

상태

읽기 전용

SubscriptionSet의 상태입니다.

유형:

Realm.App.Sync.SubscriptionSetState

버전

읽기 전용

SubscriptionSet의 버전입니다. 이 값은 Realm.App.Sync.SubscriptionSet#update 이 적용될 때마다 증가합니다.

유형:

number

update(콜백)Promise<void>

SubscriptionSet를 업데이트하고 이 인스턴스가 업데이트된 SubscriptionSet을 가리키도록 변경합니다.

세트에서 구독을 추가하거나 제거하는 작업은 이 메서드의 콜백 인수 내에서 수행해야 하며, 변경하는 메서드는 원래 Realm.App.Sync.SubscriptionSet 인스턴스가 아닌 mutableSubs 인수에서 호출해야 합니다.

콜백이 실행된 후 구독에 대한 모든 변경 사항은 배치되어 서버로 전송됩니다. update 에 대한 await 호출을 수행하거나 Realm.App.Sync.SubscriptionSet#waitForSynchronization 를 호출하여 새 데이터를 사용할 수 있을 때까지 기다릴 수 있습니다.

예시:

await realm.subscriptions.update(mutableSubs => {
  mutableSubs.add(realm.objects("Cat").filtered("age > 10"));
  mutableSubs.add(realm.objects("Dog").filtered("age > 20"));
  mutableSubs.removeByName("personSubs");
});
// `realm` will now return the expected results based on the updated subscriptions

매개변수:

콜백

유형: function
세트에서 구독을 추가하거나 제거하는 데 사용할 수 있는 Realm.App.Sync.MutableSubscriptionSet 인스턴스를 첫 번째 인수로 받고, SubscriptionSet와 연결된 Realm을 두 번째 인수로 받는 콜백 함수 (주로 initialSubscriptions 에서 Realm.App.Sync~FlexibleSyncConfiguration 2}로 작업할 때 유용합니다) ).

참고: 콜백은 비동기식이어서는 안 됩니다.

반환 값: Promise<void> SubscriptionSet가 동기화되면 해결되거나 동기화 중에 오류가 발생한 경우 거부되는 promise( waitForSynchronisation 참조)

waitForSynchronization()Promise<void>

서버가 이 구독 세트를 확인하고 일치하는 객체를 반환할 때까지 기다립니다.

state 이 Realm.App.Sync.SubscriptionSetState.Complete 이면 promise가 즉시 해결됩니다.

state 가 Realm.App.Sync.SubscriptionSetState.Error 인 경우 promise는 즉시 거부됩니다.

반환 값: Promise<void> 동기화가 완료되면 해결되거나 동기화 중에 오류가 있는 경우 거부되는 프로미스입니다.

매(콜백, thisArg)boolean

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype.every

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 실행할 함수입니다. 이 함수가 모든 객체에 대해 true 을 반환하면 이 메서드는 true 을 반환합니다. 이 함수는 세 개의 인수를 사용합니다:
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

thisArg 옵션

유형: object
callback 이(가) 호출될 때의 this 값입니다.

반환 값: 가 SubscriptionSet의 모든 객체에 boolean 대해 을 callback 반환했는지 여부를 나타내는 .true

이후: 0.11.0

findByName(name)Realm.App.Sync.Subscription or null

이름으로 구독을 찾습니다.

매개변수:

이름

유형: string
검색할 이름입니다.

반환 값: Realm.App.Sync.Subscription 또는 null 명명된 구독, 또는 구독을 찾을 수 없는 경우 null .

findByQuery(쿼리)Realm.App.Sync.Subscription or null

쿼리로 구독을 찾습니다. 명명된 구독과 명명되지 않은 구독 모두와 일치합니다.

매개변수:

쿼리

유형: Realm.Results
Realm.Results 인스턴스로 표시되는 검색할 쿼리입니다. Realm.objects("Cat").filtered("age > 10").

반환 값: Realm.App.Sync.Subscription 또는 null 지정된 쿼리가 있는 구독, 또는 구독을 찾을 수 없는 경우 null 를 반환합니다.

forEach(콜백, thisArg)

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype.forEach

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 실행할 함수입니다. 이 함수는 세 개의 인수를 사용합니다:
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

thisArg 옵션

유형: object
callback 이(가) 호출될 때의 this 값입니다.

이후: 0.11.0

map(콜백, thisArg)[any, ...]

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype.map

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 실행할 함수입니다. 이 함수는 세 개의 인수를 사용합니다:
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

thisArg 옵션

유형: object
callback 이(가) 호출될 때의 this 값입니다.

반환 값: [any, ...] - SubscriptionSet의 모든 객체에 대해 호출된 후 callback 의 값을 반환합니다.

이후: 0.11.0

reduce(콜백, 초기 값)any

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype.reduce

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 실행할 함수입니다. 이 함수는 네 개의 인수를 사용합니다:
- previousValue - 콜백의 마지막 호출에서 이전에 반환된 값 또는 initialValue(제공된 경우)입니다.
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

초기 값 옵션

유형: object
callback 의 첫 번째 호출에 대한 첫 번째 인수로 사용할 값입니다.

예외 처리:

TypeError
- SubscriptionSet가 비어 있고 initialValue 이 제공되지 않은 경우입니다.

반환 값: any - 다음과 같은 특수한 경우를 제외하고 , callback 의 최종 호출에서 반환된 값입니다.

SubscriptionSet가 단일 객체로 구성되어 있고 initalValue 이 제공되지 않은 경우 해당 객체가 반환됩니다.
SubscriptionSet가 비어 있으면 initialValue 를 제공 해야 하며 이 반환됩니다.

이후: 0.11.0

reduceRright(콜백, 초기 값)any

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype.reduceRright

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 오른쪽에서 왼쪽 으로 실행할 함수입니다. 이 함수는 네 개의 인수를 사용합니다:
- previousValue - 콜백의 마지막 호출에서 이전에 반환된 값 또는 initialValue(제공된 경우)입니다.
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

초기 값 옵션

유형: object
callback 의 첫 번째 호출에 대한 첫 번째 인수로 사용할 값입니다.

예외 처리:

TypeError
- SubscriptionSet가 비어 있고 initialValue 이 제공되지 않은 경우입니다.

반환 값: any - 다음과 같은 특수한 경우를 제외하고 , callback 의 최종 호출에서 반환된 값입니다.

SubscriptionSet가 단일 객체로 구성되어 있고 initalValue 이 제공되지 않은 경우 해당 객체가 반환됩니다.
SubscriptionSet가 비어 있으면 initialValue 를 제공 해야 하며 이 반환됩니다.

이후: 0.11.0

some(콜백, thisArg)boolean

사용 중단됨: v12.0.0에서 제거될 예정입니다.

참조: Array.prototype. 일부

매개변수:

콜백

유형: function
SubscriptionSet의 각 객체에 대해 실행할 함수입니다. 이 함수가 true 을 반환하면 이 메서드는 true 을 반환합니다. 이 함수는 세 개의 인수를 사용합니다:
- object - SubscriptionSet에서 처리 중인 현재 객체입니다.
- index - SubscriptionSet에서 처리 중인 객체의 인덱스입니다.
- subscriptionSet - SubscriptionSet 자체입니다.

thisArg 옵션

유형: object
callback 이(가) 호출될 때의 this 값입니다.

반환 합니다: 가 SubscriptionSet의 객체에 boolean true 대해 를 반환하는 callback 경우 true false - , 그렇지 않으면 .

이후: 0.11.0

Realm ~App .Sync.SubscriptionSet

확장

멤버

유형:

유형:

유형:

유형:

유형:

방법

매개변수:

상속된 메서드

매개변수:

매개변수:

매개변수:

매개변수:

매개변수:

매개변수:

예외 처리:

매개변수:

예외 처리:

매개변수: