CHEQROOM

Class: Base

Base

new Base()

base.js, line 35
Properties:
Name Type Description
dsAttachments ApiDataSource

attachments datasource
crtype string

e.g. cheqroom.types.customer
modified moment

last modified timestamp
flag string

the document flag
fields object

dictionary of document fields
comments array

array of Comment objects
attachments array

array of Attachment objects
cover string

cover attachment id, default null

Extends

Members

addBarcode

Adds a barcode

clearFlag

Clears the flag of an item

clearLabel

Clears the label of an item

isDirty

Checks if the base is dirty and needs saving

setFlag

Sets the flag of an item

setLabel

Sets the label of an item

updateFields

Update fields of a document

Methods

addComment(comment, skipRead){promise}

base.js, line 122

Adds a comment by string

Name Type Description
comment
skipRead

attach(attachmentId, skipRead){promise}

base.js, line 314

attaches an Attachment object

Name Type Description
attachmentId
skipRead

canDelete(){promise}

base.js, line 104

Checks via the api if we can delete the document

clearCover(skipRead){promise}

base.js, line 299

Clears the cover image

Name Type Description
skipRead

clearField(field, skipRead)

base.js, line 215

Clears a custom field

Name Type Description
field
skipRead

inherited create(skipRead){promise}

document.js, line 132

Creates an object by the default api.create

Name Type Description
skipRead

skips reading the response via _fromJson (false)

inherited delete(){promise}

document.js, line 172

Deletes an object by the default api.delete

deleteComment(id, skipRead){promise}

base.js, line 155

Deletes a Comment by id

Name Type Description
id
skipRead

detach(attachmentId, skipRead){promise}

base.js, line 334

detaches an Attachment by kvId (guid)

Name Type Description
attachmentId
skipRead

inherited discardChanges(){promise}

document.js, line 87

Discards any changes made to the object from the previously loaded raw response or resets it when no old raw response was found

inherited existsInDb(){boolean}

document.js, line 45

Checks if the document exists in the database

inherited get(_fields){promise}

document.js, line 113

Gets an object by the default api.get

Name Type Description
_fields

isEmpty(){boolean}

base.js, line 75

Checks if the object is empty after calling reset() isEmpty() should return true We'll only check for fields, comments, attachments here

inherited isValid(){boolean}

document.js, line 77

Checks if the object is valid

inherited reload(_fields){promise}

document.js, line 98

Reloads the object from db

Name Type Description
_fields

inherited reset(){promise}

document.js, line 34

Resets the object

setCover(att, skipRead){promise}

base.js, line 283

Set the cover image to an Attachment

Name Type Description
att
skipRead

setField(field, value, skipRead){promise}

base.js, line 198

Sets a custom field

Name Type Description
field
value
skipRead

setFields(fields, skipRead){promise}

base.js, line 173

Sets multiple custom fields in a single call

Name Type Description
fields
skipRead

inherited update(skipRead){promise}

document.js, line 152

Updates an object by the default api.update

Name Type Description
skipRead

skips reading the response via _fromJson (false)

updateComment(id, comment, skipRead){promise}

base.js, line 138

Updates a comment by id

Name Type Description
id
comment
skipRead