Class SharedObject

Common object class

SharedObject

Index

Constructors

Properties

asJSON id objectType persistentID statusInfo title

Methods

doCut getClassName getPersistentJSON isMarked locked setMarked

Constructors

constructor

new SharedObject(): SharedObject
Returns SharedObject
Inherited from SharedBase.constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

id

id: number

Gets integer id of the object

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Gets the object title

Methods

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:213

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedBase.getClassName
- Defined in src/types/Native.ts:198

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
- Defined in src/types/Native.ts:214

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
- Defined in src/types/Native.ts:212

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedBase.locked
- Defined in src/types/Native.ts:192

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
- Defined in src/types/Native.ts:211