otrs -> rel-6_0 API documentation

NAME

Kernel::System::SearchProfile - module to manage search profiles

DESCRIPTION

module with all functions to manage search profiles

PUBLIC INTERFACE

new()

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

my $SearchProfileObject = $Kernel::OM->Get('Kernel::System::SearchProfile');

SearchProfileAdd()

to add a search profile item

$SearchProfileObject->SearchProfileAdd(
    Base      => 'TicketSearch',
    Name      => 'last-search',
    Key       => 'Body',
    Value     => $String,    # SCALAR|ARRAYREF
    UserLogin => 123,
);

SearchProfileGet()

returns hash with search profile.

my %SearchProfileData = $SearchProfileObject->SearchProfileGet(
    Base      => 'TicketSearch',
    Name      => 'last-search',
    UserLogin => 'me',
);

SearchProfileDelete()

deletes a search profile.

$SearchProfileObject->SearchProfileDelete(
    Base      => 'TicketSearch',
    Name      => 'last-search',
    UserLogin => 'me',
);

SearchProfileList()

returns a hash of all profiles for the given user.

my %SearchProfiles = $SearchProfileObject->SearchProfileList(
    Base      => 'TicketSearch',
    UserLogin => 'me',
);

SearchProfileUpdateUserLogin()

changes the UserLogin of SearchProfiles

my $Result = $SearchProfileObject->SearchProfileUpdateUserLogin(
    Base         => 'TicketSearch',
    UserLogin    => 'me',
    NewUserLogin => 'newme',
);

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.