Class SheetHandleImpl

constructor

• new SheetHandleImpl(
      key: string,
      data: SheetExport,
      meta: LocalSheetMetadata,
      mgr: SheetManagerImpl,
  ): SheetHandleImpl

  Parameters

  • key: string
  • data: SheetExport
  • meta: LocalSheetMetadata
  • mgr: SheetManagerImpl

  Returns SheetHandleImpl

Readonlykey

meta

busy

• get busy(): boolean

  Whether or not an action posted with doAction is currently in progress.

  Returns boolean

conflictResolutionStrategy

• get conflictResolutionStrategy(): ConflictResolutionStrategy

  Returns ConflictResolutionStrategy

• set conflictResolutionStrategy(value: ConflictResolutionStrategy): void

  Parameters

  • value: ConflictResolutionStrategy

  Returns void

dataNow

• get dataNow(): SheetExport

  Returns SheetExport

displayable

• get displayable(): boolean

  Whether the sheet should be displayed to the user.

  Returns boolean

hasConflict

• get hasConflict(): boolean

  Returns boolean

ilvlSync

• get ilvlSync(): number

  Returns number

isTrash

• get isTrash(): boolean

  Returns boolean

job

• get job(): | "PLD"
  | "WAR"
  | "DRK"
  | "GNB"
  | "WHM"
  | "SCH"
  | "AST"
  | "SGE"
  | "MNK"
  | "DRG"
  | "NIN"
  | "SAM"
  | "RPR"
  | "VPR"
  | "BRD"
  | "MCH"
  | "DNC"
  | "BLM"
  | "SMN"
  | "RDM"
  | "PCT"
  | "BLU"

  Returns
      | "PLD"
      | "WAR"
      | "DRK"
      | "GNB"
      | "WHM"
      | "SCH"
      | "AST"
      | "SGE"
      | "MNK"
      | "DRG"
      | "NIN"
      | "SAM"
      | "RPR"
      | "VPR"
      | "BRD"
      | "MCH"
      | "DNC"
      | "BLM"
      | "SMN"
      | "RDM"
      | "PCT"
      | "BLU"

lastSyncedVersion

• get lastSyncedVersion(): number

  The last version of the sheet that was uploaded to the server.

  Returns number

• set lastSyncedVersion(version: number): void

  Parameters

  • version: number

  Returns void

level

• get level(): number

  Returns number

localVersion

• get localVersion(): number

  The local version of the sheet.

  Returns number

• set localVersion(version: number): void

  Parameters

  • version: number

  Returns void

metaKey

• get metaKey(): string

  Returns string

multiJob

• get multiJob(): boolean

  Returns boolean

name

• get name(): string

  Returns string

serverVersion

• get serverVersion(): number

  The highest version of the sheet that the server has, but has not necessarily been downloaded.

  Returns number

sortOrder

• get sortOrder(): number

  The sort order of this sheet.

  Returns number

• set sortOrder(sortOrder: number): void

  Change the sort order of this sheet. Set null to use the natural/default sort.

  Parameters

  • sortOrder: number

  Returns void

summary

• get summary(): SheetSummary

  Returns SheetSummary

• set summary(value: SheetSummary): void

  Parameters

  • value: SheetSummary

  Returns void

syncStatus

• get syncStatus(): SyncStatus

  Returns SyncStatus

trueSyncStatus

• get trueSyncStatus(): SyncStatus

  Returns SyncStatus

deleteLocal

• deleteLocal(): void

  Returns void

deleteServerToClient

• deleteServerToClient(serverVersion: number): void

  Parameters

  • serverVersion: number

  Returns void

doAction

• doAction<X>(action: Promise<X>): Promise<X>

  Perform an asynchronous action. Marks the sheet handle as busy until the promise resolves. Returns the original argument so that you can do things like:

  const result = await sheet.doAction(doSomethingAsync());
  Copy

  Type Parameters

  • X

  Parameters

  • action: Promise<X>

  Returns Promise<X>

flush

• flush(): void

  Save the sheet and metadata.

  Returns void

markDataDirty

• markDataDirty(): void

  Returns void

markMetaDirty

• markMetaDirty(): void

  Returns void

postDownload

• postDownload(
      serverVersion: number,
      data: SheetExport,
      sortOrder: number,
      versionKey: number,
  ): void

  Update the metadata after downloading a new version of the sheet.

  Parameters

  • serverVersion: number
  • data: SheetExport
  • sortOrder: number
  • versionKey: number

  Returns void

postLocalModification

• postLocalModification(data: SheetExport): void

  Set new data and bump version.

  Parameters

  • data: SheetExport

  Returns void

readData

• readData(): Promise<SheetExport>

  Read the data.

  Returns Promise<SheetExport>

saveLocalAsDefault

• saveLocalAsDefault(): SheetHandle

  Returns SheetHandle

setServerVersion

• setServerVersion(serverVersion: number, versionKey: number): void

  Inform the handle of a new server serverVersion which is NOT a deletion

  Parameters

  • serverVersion: number
  • versionKey: number

  Returns void