/ 
App-DesktopNotifyUtils-0.001
River stage zero No dependents
/ App::DesktopNotifyUtils

NAME

App::DesktopNotifyUtils - Utilities related to Desktop::Notify

VERSION

This document describes version 0.001 of App::DesktopNotifyUtils (from Perl distribution App-DesktopNotifyUtils), released on 2024-08-30.

SYNOPSIS

DESCRIPTION

This distribution includes several utilities:

#INSERT_EXECS_LIST

FUNCTIONS

notify_desktop

Usage:

notify_desktop(%args) -> [$status_code, $reason, $payload, \%result_meta]

Show a notification on your desktop.

Currently a very simple interface to Desktop::Notify. Will offer more options in the future.

This function is not exported.

Arguments ('*' denotes required arguments):

  • body => str

    (No description)

  • summary* => str

    (No description)

  • timeout => uint (default: 5000)

    Timeout, in ms.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-DesktopNotifyUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-DesktopNotifyUtils.

SEE ALSO

Desktop::Notify

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-DesktopNotifyUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.