
##############
Autocompletion
##############


new()
=====


Don't use the constructor directly, use the ObjectManager instead:


.. code-block:: perl

     my $AutocompletionObject = $Kernel::OM->Get('Kernel::System::Autocompletion');



GetData()
=========



.. code-block:: perl

     Returns data for autocompletion of given trigger.
 
     my $Data = $AutocompletionObject->GetData(
         Trigger          => '!EX', # !EX is from example autocompletion module Kernel::System::Autocompletion::Example
         SearchString     => 'Raw',
         UserID           => 2,
         AdditionalParams => { # optional
             TicketID => 3, # this will only be passed if available (e.g. it's not available for AgentTicketPhone)
         },
     );
 
     Returns:
 
     my $Data = [
         {
             id                   => 3,
             selection_list_title => 'Raw',
             inserted_value       => 'Raw (3)',
         },
     ];



GetAutocompletionSettings()
===========================



.. code-block:: perl

     Returns a hash with autocompletion settings by trigger.
 
     my $AutocompletionSettings = $AutocompletionObject->GetAutocompletionSettings();
 
     Returns:
 
     my $AutocompletionSettings = {
         ItemTemplate    => '<li data-id={id}>{selection_list_title}</li>',
         OutputTemplate  => '{inserted_value}',
         MinSearchLength => 3,
         Triggers        => {
             '!EX' => {
                 Module  => 'Example',
                 Trigger => '!EX',
             },
         },
     };



