Class UserDataSyncer

Index

Constructors

Accessors

Methods

downloadSettings onSheetChange prepSheetSync startRefreshLoop syncOne syncSheets triggerRefreshNow uploadSettings

Constructors

constructor

new UserDataSyncer(
    accountStateTracker: AccountStateTracker,
    userDataClient: UserDataClient<never>,
    settings: DisplaySettings,
    sheetMgr: SheetManager,
): UserDataSyncer
Parameters
- accountStateTracker: AccountStateTracker
- userDataClient: UserDataClient<never>
- settings: DisplaySettings
- sheetMgr: SheetManager
Returns UserDataSyncer
- Defined in packages/frontend/src/scripts/account/user_data.ts:43

Accessors

available

get available(): boolean
Returns boolean
- Defined in packages/frontend/src/scripts/account/user_data.ts:428

Methods

downloadSettings

downloadSettings(): Promise<"success" | "not-logged-in" | "none-saved">
Returns Promise<"success" | "not-logged-in" | "none-saved">
- Defined in packages/frontend/src/scripts/account/user_data.ts:86

onSheetChange

onSheetChange(): void
Returns void
- Defined in packages/frontend/src/scripts/account/user_data.ts:424

prepSheetSync

prepSheetSync(): Promise<
    "not-logged-in"
    | "nothing-to-do"
    | "cancelled"
    | "need-sync",
>
Asks the server about what sheets and sheet versions it has.

Returns Promise<"not-logged-in" | "nothing-to-do" | "cancelled" | "need-sync">
- Defined in packages/frontend/src/scripts/account/user_data.ts:152

startRefreshLoop

startRefreshLoop(): void
Returns void
- Defined in packages/frontend/src/scripts/account/user_data.ts:414

syncOne

syncOne(
sheetHandle: SheetHandle,
): Promise<"success" | "not-logged-in" | "nothing-to-do">
Parameters
- sheetHandle: SheetHandle
Returns Promise<"success" | "not-logged-in" | "nothing-to-do">
- Defined in packages/frontend/src/scripts/account/user_data.ts:234

syncSheets

syncSheets(): Promise<
    "success"
    | "not-logged-in"
    | "nothing-to-do"
    | "cancelled",
>
Returns Promise<"success" | "not-logged-in" | "nothing-to-do" | "cancelled">
- Defined in packages/frontend/src/scripts/account/user_data.ts:134

triggerRefreshNow

triggerRefreshNow(): Promise<void>
Returns Promise<void>
- Defined in packages/frontend/src/scripts/account/user_data.ts:418

uploadSettings

uploadSettings(): Promise<"success" | "not-logged-in" | "suppressed">
Returns Promise<"success" | "not-logged-in" | "suppressed">
- Defined in packages/frontend/src/scripts/account/user_data.ts:114