StateManagementService

@group

Services/State Management

Index

Constructors

• constructor

Methods

• getAppLock
• getModelState
• getResourceState
• getState
• isAppLocked
• lockApp
• saveModelState
• saveResourceState
• saveState
• unlockApp
• updateAppLockTransaction

Constructors

constructor

• StateManagementService(stateProvider: IStateProvider): StateManagementService

• Parameters

  • stateProvider: IStateProvider

  Returns StateManagementService

Methods

getAppLock

• getAppLock(): Promise<undefined | string>

• Returns Promise<undefined | string>

getModelState

• getModelState(stateFileName: string, __namedParameters?: { freeze?: boolean }): Promise<{ data: ModelSerializedOutput; userData: object }>

• Parameters

  • stateFileName: string

  • __namedParameters: { freeze?: boolean } = {}

  • optionalfreeze: boolean = true

  Returns Promise<{ data: ModelSerializedOutput; userData: object }>

getResourceState

• getResourceState(stateFileName: string, __namedParameters?: { freeze?: boolean }): Promise<{ data: ResourceSerializedOutput; userData: object }>

• Parameters

  • stateFileName: string

  • __namedParameters: { freeze?: boolean } = {}

  • optionalfreeze: boolean = true

  Returns Promise<{ data: ResourceSerializedOutput; userData: object }>

getState

• getState(stateFileName: string, defaultValue?: any): Promise<Buffer<ArrayBufferLike>>

• Parameters

  • stateFileName: string

  • optionaldefaultValue: any

  Returns Promise<Buffer<ArrayBufferLike>>

isAppLocked

• isAppLocked(lockId: string): Promise<boolean>

• Parameters

  • lockId: string

  Returns Promise<boolean>

lockApp

• lockApp(): Promise<{ lockId: string }>

• Returns Promise<{ lockId: string }>

saveModelState

• saveModelState(stateFileName: string, data: ModelSerializedOutput, userData: object): Promise<void>

• Parameters

  • stateFileName: string

  • data: ModelSerializedOutput

  • userData: object

  Returns Promise<void>

saveResourceState

• saveResourceState(stateFileName: string, data: ResourceSerializedOutput, userData: object): Promise<void>

• Parameters

  • stateFileName: string

  • data: ResourceSerializedOutput

  • userData: object

  Returns Promise<void>

saveState

• saveState(stateFileName: string, data: Buffer): Promise<void>

• Parameters

  • stateFileName: string

  • data: Buffer

  Returns Promise<void>

unlockApp

• unlockApp(lockId: string): Promise<void>

• Parameters

  • lockId: string

  Returns Promise<void>

updateAppLockTransaction

• updateAppLockTransaction(lockId: string): Promise<void>

• Parameters

  • lockId: string

  Returns Promise<void>