Realm 인스턴스에 대한 모든 활성 Flexible Sync 구독 세트를 나타냅니다.

서버는 인스턴스가 구독한 쿼리를 지속적으로 평가하여 일치하는 데이터를 전송하고 더 이상 그렇지 않은 데이터를 제거합니다.

구독 세트는 해당 MutableSubscriptionSet 인스턴스의 메서드를 호출하여 SubscriptionSet.update 콜백 내에서만 수정할 수 있습니다.

계층 구조( 전체 보기 )

생성자

접근자

  • get 오류(): null | 문자열
  • stateSubscriptionSetState.Error 인 경우 이는 SubscriptionSet 가 오류 상태인 이유를 나타내는 문자열입니다. 오류가 없으면 null 가 됩니다.

    null반환 | 문자열

    오류를 나타내는 문자열이거나 오류가 없는 경우 null 입니다.

  • get isEmpty(): 부울
  • 세트에 구독이 없는지 여부입니다.

    반환 부울

    true 세트에 구독이 없으면 false 를 반환합니다.

  • 길이 가져오기 (): 숫자
  • 숫자반환

    세트의 구독 수입니다.

  • 상태 가져오기 (): SubscriptionSetState
  • SubscriptionSetState를반환합니다.

    SubscriptionSet의 상태입니다.

  • 버전 가져오기 (): 숫자
  • SubscriptionSet의 버전입니다. 이 값은 SubscriptionSet.update 가 적용될 때마다 증가합니다.

    숫자반환

    SubscriptionSet 의 버전입니다.

방법

  • 구독 세트를 반복 가능하게 만듭니다.

    IterableIterator<구독>을 반환합니다.

    세트의 각 값에 대해 반복 가능합니다.

    예시

    for (const subscription of subscriptions) {
    // ...
    }
  • 이름으로 구독을 찾습니다.

    매개변수

    • name: 문자열

      검색할 이름입니다.

    null반환 | 구독

    명명된 구독이거나, 구독을 찾을 수 없는 경우 null 입니다.

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

    유형 매개변수

    • 서브스크립션

    매개변수

    null반환 | 구독

    지정된 쿼리가 있는 구독이거나 구독을 찾을 수 없는 경우 null 입니다.

  • 세트에서 구독을 추가하거나 제거하는 등 콜백 내부에서 이 SubscriptionSet를 변경하려면 이 함수를 호출합니다.

    MutableSubscriptionSet 인수는 콜백에서만 사용할 수 있으며 반환된 후에는 사용하면 안 됩니다.

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

    매개변수

    • callback: ( ((MutableSubscriptions, 영역) => void)

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

    Promise<void>를 반환합니다.

    SubscriptionSet가 동기화되면 해결되거나 동기화 중에 오류가 발생한 경우 거부되는 promise입니다( SubscriptionSet.waitForSynchronization 참조).

    예시

    await realm.subscriptions.update(mutableSubscriptions => {
    mutableSubscriptions.add(realm.objects("Cat").filtered("age > 10"));
    mutableSubscriptions.add(realm.objects("Dog").filtered("age > 20"), { name: "oldDogs" });
    mutableSubscriptions.removeByName("youngDogs");
    });
    // `realm` will now return the expected results based on the updated subscriptions
  • 서버가 이 구독 세트를 확인하고 일치하는 객체를 반환할 때까지 기다립니다.

    stateSubscriptionSetState.Complete 인 경우 promise는 즉시 해결됩니다.

    stateSubscriptionSetState.Error 인 경우 promise는 즉시 거부됩니다.

    Promise<void>를 반환합니다.

    동기화가 완료되면 해결되거나 동기화 중에 오류가 발생하면 거부되는 프로미스입니다.

TypeDoc을 사용하여 생성됨