Class: Contact

Extends

• Base

Members

addBarcode

Adds a barcode

archive

Archive a contact

canArchive

Checks if a contact can be archived (based on status)

canCheckout

Checks if a contact can be used in a checkout (based on status)

canDelete

Checks if a contact can be deleted (based on status and link to user)

canGenerateDocument

Checks if we can generate a document for this contact (based on status)

canReserve

Checks if a contact can be used in a reservation (based on status)

canUndoArchive

Checks if a contact can be unarchived (based on status)

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

undoArchive

Undo archive of a contact

updateFields

Update fields of a document

Methods

inherited addComment(comment, skipRead){promise}

base.js, line 122

Adds a comment by string

Name	Type	Description
comment
skipRead

inherited attach(attachmentId, skipRead){promise}

base.js, line 314

attaches an Attachment object

Name	Type	Description
attachmentId
skipRead

inherited clearCover(skipRead){promise}

base.js, line 299

Clears the cover image

Name	Type	Description
skipRead

inherited 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

inherited deleteComment(id, skipRead){promise}

base.js, line 155

Deletes a Comment by id

Name	Type	Description
id
skipRead

inherited 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

generateDocument(template, signature, skipRead){promise}

contact.js, line 177

Generates a PDF document for the reservation

Name	Type	Description
template	string	id
signature	string	(base64)
skipRead	bool

inherited get(_fields){promise}

document.js, line 113

Gets an object by the default api.get

Name	Type	Description
_fields

getUserId(){string}

contact.js, line 77

If the contact is linked to a user, return its user id Remark: needs field user

getUserSync(){string}

contact.js, line 89

Checks if the user is a synced user Remark: needs field user

inherited 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

isValid(){boolean}

contact.js, line 194

Checks if the contact has any validation errors

isValidEmail(){Boolean}

contact.js, line 66

Check is email is valid

isValidName(){Boolean}

contact.js, line 55

Checks if name 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

inherited setCover(att, skipRead){promise}

base.js, line 283

Set the cover image to an Attachment

Name	Type	Description
att
skipRead

inherited setField(field, value, skipRead){promise}

base.js, line 198

Sets a custom field

Name	Type	Description
field
value
skipRead

inherited 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)

inherited updateComment(id, comment, skipRead){promise}

base.js, line 138

Updates a comment by id

Name	Type	Description
id
comment
skipRead