Xivgear Types Documentation
    Preparing search index...

    Type Alias LocalSheetMetadata

    type LocalSheetMetadata = {
        currentVersion: number;
        forcePush: boolean;
        hasConflict: boolean;
        lastSyncedVersion: number;
        localDeleted: boolean;
        serverDeleted: boolean;
        serverVersion: number;
        sortOrder: number | null;
        summary: SheetSummary;
        unsyncedModifications?: SheetModificationRecord[];
    }
    Index

    Properties

    currentVersion forcePush hasConflict lastSyncedVersion localDeleted serverDeleted serverVersion sortOrder summary unsyncedModifications?

    Properties

    currentVersion: number

    The current numeric version of the sheet. Should be incremented upon modifications.

    forcePush: boolean

    True if the user data sync process should force push to the server.

    hasConflict: boolean

    True if the sheet has some kind of sync conflict.

    lastSyncedVersion: number

    The version of the sheet that was last uploaded to the server. Zero if it has never been uploaded.

    localDeleted: boolean

    True if the sheet was deleted locally.

    serverDeleted: boolean

    True if the sheet is deleted from the server.

    serverVersion: number

    The version of the sheet that the server is confirmed to have. Zero if the server does not have it.

    sortOrder: number | null

    The sort order of the sheet. Null indicates that the sheet should use the default sort order.

    summary: SheetSummary
    unsyncedModifications?: SheetModificationRecord[]

    Settings

    Member Visibility

    On This Page

    Properties