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     => 'Ticket',
        PluginData    => '42',
        UserID        => 1,
    );

PluginLinkList()

returns list of links for supplied appointment

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

PluginLinkListData()

Returns a list of links for supplied appointment which is split in some keys.

    my $LinkListData = $PluginObject->PluginLinkListData(
        AppointmentID => 1,
        PluginKey     => 'Ticket',
        UserID        => 1,
    );

Returns [ { ID => 1, Number => '123', Title => 'Some Title', }, ],

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)
    );