NAME

Kernel::System::DashboardNewsWidget – dashboard news widget lib

DESCRIPTION

All dashboard news widget 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 $DashboardNewsWidgetObject = $Kernel::OM->Get('Kernel::System::DashboardNewsWidget');

AnnouncementAdd()

add new announcements

    my $Success = $DashboardNewsWidgetObject->AnnouncementAdd(
        Title        => 'New Announcement',
        Announcement => "--\nSome Announcement Infos",
        UserID       => 123,
    );

AnnouncementGet()

get announcement attributes

    my $Announcement = $DashboardNewsWidgetObject->AnnouncementGet(
        ID => 123,
    );

AnnouncementUpdate()

update announcement attributes

    $Success = $DashboardNewsWidgetObject->AnnouncementUpdate(
        ID           => 123,
        Title        => 'Updated Announcement',
        Announcement => "--\nSome Updated Announcements Infos",
        UserID       => 123,
    );

AnnouncementList()

get announcement list

    my $List = $DashboardNewsWidgetObject->AnnouncementList(
        # Result limit
        Limit => 10000,

        # OrderBy and SortBy (optional)
        OrderBy => 'Down',  # Down|Up
        SortBy  => 'title',   # Created, Changed
    );

AnnouncementDelete()

delete announcements

    my $Success = $DashboardNewsWidgetObject->AnnouncementDelete(
        ID => 123,
    );