CHEQROOM

Class: UserSync

UserSync

UserSync

new UserSync()

usersync.js, line 40
Properties:
Name Type Description
kind string

The kind
name string

The name
host string

The url of the host
port int

The port number
timeOut int

The timeOut in seconds
login string

The login for the host
password string

The password for the host
newUsers string

What to with new Users (ignore, create)
existingUsers string

What to with existing Users (ignore, update)
missingUsers string

What to with missing Users (ignore, archive, deactivate)
autoSync boolean

Do a nightly sync automatically?
role string

Sync users under which role? (selfservice, user, admin)
query string

The query
base string

The base
loginField string

The loginField
nameField string

The nameField
emailField string

The emailField

Extends

Members

addBarcode

Adds a barcode

clearFlag

Clears the flag of an item

clearLabel

Clears the label of an item

clone

Clones the template to a new one

setFlag

Sets the flag of an item

setLabel

Sets the label of an item

syncUsers

Tests the specified sync

testConnection

Tests the specified connection

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 canDelete(){promise}

base.js, line 104

Checks via the api if we can delete the document

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

inherited get(_fields){promise}

document.js, line 113

Gets an object by the default api.get

Name Type Description
_fields

isDirty(){boolean}

usersync.js, line 158

Checks if the user is dirty and needs saving

isEmpty(){boolean}

usersync.js, line 127

Checks if the user is empty

isValid(){boolean}

usersync.js, line 115

Checks if the usersync 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