OTRS API Reference JavaScript

Namespace: Core.SystemConfiguration

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration.Date module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source:

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source:

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration.WorkingHours module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source:

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration.DateTime module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source:

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration.VacationDaysOneTime module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source:

Core. SystemConfiguration

This namespace contains the special functions for SystemConfiguration.VacationDays module.
Author:
  • OTRS AG
Source:

Methods

(static) AddArrayItem($Object)

Add new item to the array
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) AddHashKeyClick($Object)

Handle add new hash key
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) CheckboxValueSet($Object)

This function sets the hidden input field value according to the checkbox($Object) state.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) Init()

This function initializes module functionality.
Source:

(static) InitButtonVisibility($Object)

Initialize add button visibility.
Parameters:
Name Type Description
$Object jQueryObject jQueryObject
Source:

(static) InitConfigurationTree(RedirectAction, Category, UserModificationActive) → {Boolean}

This function initializes Configuration Tree
Parameters:
Name Type Description
RedirectAction String Action parameter for next http request.
Category String If a category should be considered when the tree is rendered (category key)
UserModificationActive String Limit to settings that can be modified by users.
Source:
Returns:
- redirect
Type
Boolean

(static) RemoveItem($Object)

Remove complete item from the array/hash
Parameters:
Name Type Description
$Object jQueryObject jquery object.
Source:

(static) RevertToHistoricalValue($Object) → {Boolean}

Delete user setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object
Source:
Returns:
- false in case delete all values is not needed
Type
Boolean

(static) SettingRender(Response, $Widget)

This function renders setting received by AJAX call(Response) to the provided $Widget.
Parameters:
Name Type Description
Response Object AJAX response
$Widget jQueryObject jQueryObject
Source:

(static) SettingReset($Object, ResetOptions)

Reset setting to the default value.
Parameters:
Name Type Description
$Object jQueryObject jquery object
ResetOptions Number reset-globally,reset-locally
Source:

(static) Update($Object, ToggleValid, ToggleUserModification)

This function updates the setting.
Parameters:
Name Type Description
$Object jQueryObject jquery object.
ToggleValid Boolean toggle ValidID
ToggleUserModification Boolean toggle UserModificationActive
Source: