수업 세션

생성자

생성자

접근자

설정 연결상태 상태 URL 사용자

방법

연결알림 추가 진행알림 추가 모든서버변경 사항 다운로드 연결됨 일시 중지 다시 연결 연결알림 제거 진행 알림 제거 재개 모든로컬변경 사항 업로드

생성자

생성자

접근자

설정

  • get config(): SyncConfiguration

  • 해당 Realm이 구성된 구성의 동기화 부분을 가져옵니다.

    SyncConfiguration을반환합니다.

연결상태

  • get connectionState(): ConnectionState

  • 서버에 대한 연결의 현재 상태를 가져옵니다. 여러 세션이 동일한 기본 연결을 공유할 수 있습니다. 이 경우 모든 연결 변경 사항이 모든 세션에 전송됩니다.

    이 메서드가 Connected 을 반환하고 state() 가 Active 또는 Dying 을 반환하는 경우에만 데이터가 서버와 동기화됩니다.

    ConnectionState반환

상태

  • 상태 가져오기 (): SessionState

  • 세션의 현재 상태를 가져옵니다.

    SessionState반환

URL

  • URL 가져오기 (): 문자열

  • 이 세션이 연결된 Realm 객체 서버의 URL을 가져옵니다.

    문자열반환

사용자

방법

연결알림 추가

  • 연결알림 추가(콜백): void

  • 세션 객체에 연결 알림을 등록합니다. Realm 객체 서버에 대한 기본 연결의 변경 사항에 대한 알림이 전송됩니다.

    매개변수

    • 콜백: ConnectionNotificationCallback

      다음 인수를 사용하여 호출됩니다.

      1. newState: 연결의 새 상태
      2. oldState: 연결이 전환된 상태입니다.

    반환 값 void

    이후

    2.15.0

진행알림 추가

  • 진행알림 추가(방향, 모드, 콜백): void

  • 세션 객체에 진행 알림 콜백 등록

    매개변수

    • 방향: ProgressDirection

      등록할 진행 방향입니다.

    • 모드: ProgressMode

      등록에 사용할 진행 상황 알림 모드입니다. 둘 중 하나를 사용하면 됩니다.

      • reportIndefinitely - 콜백이 등록 취소될 때까지 등록은 활성 상태로 유지됩니다.
      • forCurrentlyOutstandingWork - 현재 전송 가능한 바이트만 동기화될 때까지 등록이 활성화됩니다.
    • 콜백: ProgressNotificationCallback

      다음 인수를 사용하여 호출됩니다.

      1. transferred: 이미 전송된 현재 바이트 수
      2. transferable: 전송 가능한 총 바이트 수(이미 전송된 바이트 수에 전송 보류 중인 바이트 수를 더한 값)

    반환 값 void

    이후

    1.12.0

모든서버변경 사항 다운로드

  • 모든서버변경 사항 다운로드(timeoutMS?): Promise<void>

  • 이 메서드는 알려진 모든 원격 변경 사항이 Realm에 다운로드되어 적용되거나 지정된 시간 제한에 도달할 때까지 성공적으로 해결되지 않는 프로미스를 반환합니다. 이 메서드가 시간 초과되더라도 다운로드는 여전히 백그라운드에서 계속됩니다.

    이 메서드는 Realm이 열기 전에는 호출할 수 없습니다.

    매개변수

    • Optional timeoutMs: 숫자

      Promise가 거부되기 전에 대기할 최대 시간(밀리초)입니다. 시간 초과를 지정하지 않으면 메서드는 영원히 대기합니다.

    Promise<void>를 반환합니다.

연결됨

  • 연결됨(): 부울

  • 세션이 현재 활성화되어 있고 서버에 연결되어 있으면 true 를 반환하고, 그렇지 않으면 false 을 반환합니다.

    반환 부울

일시 중지

  • 일시 중지(): void

  • 동기화 세션을 일시 중지합니다.

    이 메서드는 비동기식이므로 세션이 시작되었는지 확인하려면 addConnectionNotification 을 사용하여 연결 알림을 추가해야 합니다.

    이 메서드는 멱등성이 있으므로 세션이 이미 일시 중지되었거나 멀티플렉싱이 활성화된 경우 작동하지 않습니다.

    반환 값 void

    이후

    2.16.0-rc.2

다시 연결

  • 다시 연결(): void

  • 알타스 Realm Mobile Sync에 다시 연결합니다.

    이 메서드는 비동기식이므로 세션이 시작되었는지 확인하려면 addConnectionNotification 을 사용하여 연결 알림을 추가해야 합니다.

    이 메서드는 멱등성이 있으므로 세션이 이미 시작된 경우 작동하지 않습니다.

    반환 값 void

    이후

    12.2.0

연결알림 제거

  • 연결알림 제거(콜백): void

  • 이전에 addStateNotification에 등록된 상태 알림 콜백의 등록을 취소합니다. 동일한 콜백으로 함수를 여러 번 호출해도 무시됩니다.

    매개변수

    반환 값 void

    이후

    2.15.0

진행 알림 제거

  • 진행 알림 제거(콜백): void

  • 이전에 addProgressNotification 을 통해 등록된 진행 알림 콜백의 등록을 취소합니다. 동일한 콜백으로 함수를 여러 번 호출해도 무시됩니다.

    매개변수

    반환 값 void

    이후

    1.12.0

재개

  • 재개(): void

  • 일시 중지된 동기화 세션을 재개합니다.

    이 메서드는 비동기식이므로 세션이 시작되었는지 확인하려면 addConnectionNotification 을 사용하여 연결 알림을 추가해야 합니다.

    이 메서드는 멱등성이 있으므로 세션이 이미 시작되었거나 멀티플렉싱이 활성화된 경우 작동하지 않습니다.

    반환 값 void

    이후

    2.16.0-rc.2

모든로컬변경 사항 업로드

  • 모든로컬변경 사항 업로드(timeoutMS?): Promise<void>

  • 이 메서드는 알려진 모든 로컬 변경 사항이 서버에 업로드되거나 지정된 시간 제한에 도달할 때까지 성공적으로 해결되지 않는 프로미스를 반환합니다. 이 메서드가 시간 초과되더라도 업로드는 백그라운드에서 계속 진행됩니다.

    이 메서드는 Realm이 열기 전에는 호출할 수 없습니다.

    매개변수

    • Optional timeoutMs: 숫자

      Maximum amount of time to wait in milliseconds before the promise is rejected. 시간 초과를 지정하지 않으면 메서드는 영원히 대기합니다.

    Promise<void>를 반환합니다.

설정

멤버 가시성

테마

이 페이지의 내용

TypeDoc을 사용하여 생성됨