otrs -> rel-6_0 API documentation

NAME

Kernel::System::Calendar::Plugin - Plugin lib

DESCRIPTION

Abstraction layer for appointment plugins.

PUBLIC INTERFACE

new()

create an object. Do not use it directly, instead use:

use Kernel::System::ObjectManager;
local $Kernel::OM = Kernel::System::ObjectManager->new();
my $TeamObject = $Kernel::OM->Get('Kernel::System::Calendar::Plugin');

PluginList()

returns the hash of registered plugins

my $PluginList = $PluginObject->PluginList();

PluginKeys()

returns the hash of proper plugin keys for lowercase matching

my $PluginKeys = $PluginObject->PluginKeys();

PluginLinkAdd()

link appointment by plugin

my $Success = $PluginObject->PluginLinkAdd(
    AppointmentID => 1,
    PluginKey     => '0100-Ticket',
    PluginData    => '42',
    UserID        => 1,
);

PluginLinkList()

returns list of links for supplied appointment

my $LinkList = $PluginObject->PluginLinkList(
    AppointmentID => 1,
    PluginKey     => '0100-Ticket',
    UserID        => 1,
);

PluginLinkDelete()

removes all links for an appointment

my $Success = $PluginObject->PluginLinkDelete(
    AppointmentID => 1,
    UserID        => 1,
);

PluginSearch()

search for plugin objects

my $ResultList = $PluginObject->PluginSearch(
    PluginKey => $PluginKey,        # (required)

    Search    => $Search,           # (required) Search string
                                    # or
    ObjectID  => $ObjectID          # (required) Object ID

    UserID    => $Self->{UserID},   # (required)
);

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.