Class: UserSync

UserSync

UserSync

new UserSync()

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}

Adds a comment by string

Name Type Description
comment
skipRead

inherited attach(attachmentId, skipRead){promise}

attaches an Attachment object

Name Type Description
attachmentId
skipRead

inherited canDelete(){promise}

Checks via the api if we can delete the document

inherited clearCover(skipRead){promise}

Clears the cover image

Name Type Description
skipRead

inherited clearField(field, skipRead)

Clears a custom field

Name Type Description
field
skipRead

inherited create(skipRead){promise}

Creates an object by the default api.create

Name Type Description
skipRead

skips reading the response via _fromJson (false)

inherited delete(){promise}

Deletes an object by the default api.delete

inherited deleteComment(id, skipRead){promise}

Deletes a Comment by id

Name Type Description
id
skipRead

inherited detach(attachmentId, skipRead){promise}

detaches an Attachment by kvId (guid)

Name Type Description
attachmentId
skipRead

inherited discardChanges(){promise}

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}

Checks if the document exists in the database

inherited get(_fields){promise}

Gets an object by the default api.get

Name Type Description
_fields

isDirty(){boolean}

Checks if the user is dirty and needs saving

isEmpty(){boolean}

Checks if the user is empty

isValid(){boolean}

Checks if the usersync is valid

inherited reload(_fields){promise}

Reloads the object from db

Name Type Description
_fields

inherited reset(){promise}

Resets the object

inherited setCover(att, skipRead){promise}

Set the cover image to an Attachment

Name Type Description
att
skipRead

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

Sets a custom field

Name Type Description
field
value
skipRead

inherited setFields(fields, skipRead){promise}

Sets multiple custom fields in a single call

Name Type Description
fields
skipRead

inherited update(skipRead){promise}

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}

Updates a comment by id

Name Type Description
id
comment
skipRead