NAME

Kernel::System::Calendar::Team – Team lib

DESCRIPTION

All Team functions.

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::Team');

TeamList()

return a Team list as hash

    my %List = $TeamObject->TeamList(
        Valid  => 0,     # (optional)
        UserID => 1,     # (optional)
    );

TeamGet()

get a Team

    my %Team = $TeamObject->TeamGet(
        TeamID => 123,              # required
                                    # or
        Name => 'Some Team Name',   # required

        UserID => 1,                # required
    );

TeamAdd()

add a team

    my $True = $TeamObject->TeamAdd(
        Name    => 'Some Team Name',
        GroupID => 5,
        Comment => 'My comment',
        ValidID => 1,
        UserID  => 1,
    );

TeamUpdate()

update an existing Team

    my $True = $TeamObject->TeamUpdate(
        TeamID         => 123,
        Name           => 'New Name',
        GroupID        => 4,
        Comment        => 'Some comment',
        ValidID        => 1,
        UserID         => 1,
    );

TeamImport()

import a team

    my $True = $TeamObject->TeamImport(
        TeamData                  => {
            'ValidID' => '1',
            'ChangeBy' => '2',
            'CreateBy' => '2',
            'ID' => '1',
            'CreateTime' => '2016-05-10 10:32:40',
            'ChangeTime' => '2016-05-10 10:32:40',
            'UserList' => {
                '2' => 'agent_login1',
                '3' => 'agent_login2',
                '4' => 'agent_login3',
            },
            'Name' => 'MyTeamName',
            'GroupID' => '2',
            'Comment' => ''
        },
        OverwriteExistingEntities => 0,  # 0 || 1,
        UserID                    => 1,
    );

AllowedTeamList()

return allowed, valid Teams list as hash

    my %List = $TeamObject->AllowedTeamList(
        UserID       => 123,    # (required) UserID
        Valid        => 0,      # (optional) Return valid teams only, default: 1
        PreventEmpty => 1,      # (optional) Just return teams with assigned users, default: 0
    );

TeamUserAdd()

add an agent to a team

    my $True = $TeamObject->TeamUserAdd(
        TeamID     => 4,
        TeamUserID => 5,
        UserID     => 1,
    );

TeamUserRemove()

remove an agent from a team

    my $True = $TeamObject->TeamUserRemove(
        TeamID     => 4,
        TeamUserID => 5,
        UserID     => 1,
    );

TeamUserList()

return valid agents list for a team as a hash

    my %List = $TeamObject->TeamUserList(
        TeamID => 42,
        UserID => 123,
        Valid  => 1,   # (optional) Return valid user list. Default: 1.
    );

UserTeamList()

return team list for a user as a hash

    my %List = $TeamObject->UserTeamList(
        UserID => 123,
    );