otrs -> rel-6_0 API documentation

NAME

Kernel::System::ProcessManagement::Activity - Activities lib

DESCRIPTION

All Process Management Activity functions.

PUBLIC INTERFACE

new()

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

my $ActivityObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::Activity');

ActivityGet()

Get Activity info
Returned activity dialogs are limited to given interface

my $Activity = $ActivityObject->ActivityGet(
    ActivityEntityID => 'A1',
    Interface        => ['AgentInterface'],   # ['AgentInterface'] or ['CustomerInterface'] or ['AgentInterface', 'CustomerInterface'] or 'all'
);

Returns:

$Activity = {
      'Name'           => 'Activity 3'
      'CreateTime'     => '08-02-2012 13:37:00',
      'ChangeBy'       => '2',
      'ChangeTime'     => '09-02-2012 13:37:00',
      'CreateBy'       => '3',
      'ActivityDialog' => {
          '1' => 'AD5',
          '3' => 'AD7',
          '2' => 'AD6',
        },
    };

ActivityList()

Get a list of all Activities

my $Activities = $ActivityObject->ActivityList();

Returns:

$ActivityList = {
    'A1' => 'Activity 1',
    'A2' => 'Activity 2',
    'A3' => '',
};

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.