NAME

WebService::Mattermost::V4::API::Resource::Emoji - Wrapped API methods for the emoji API endpoints.

VERSION

version 0.30

DESCRIPTION

use WebService::Mattermost;

my $mm = WebService::Mattermost->new({
    authenticate => 1,
    username     => 'me@somewhere.com',
    password     => 'hunter2',
    base_url     => 'https://my.mattermost.server.com/api/v4/',
});

my $resource = $mm->api->emoji;

METHODS

custom()

Get all custom emojis.

my $response = $resource->custom();

get()

Get an emoji by its ID.

my $response = $resource->get('EMOJI-ID-HERE');

delete()

Delete an emoji by its ID.

my $response = $resource->delete('EMOJI-ID-HERE');

get_by_name()

Get an emoji by its name.

my $response = $resource->get_by_name('EMOJI-NAME-HERE');

get_image()

Get an emoji's image by its ID.

my $response = $resource->get_image('EMOJI-ID-HERE');

search()

Search custom emojis.

my $response = $resource->search({
    # Required arguments
    term => 'Term here',

    # Optional arguments
    prefix_only => 'Prefix here',
});

autocomplete()

Autocomplete an emoji name.

my $response = $resource->autocomplete('START-OF-EMOJI-NAME');

SEE ALSO

Official Emoji documentation

AUTHOR

Mike Jones <mike@netsplit.org.uk>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Mike Jones.

This is free software, licensed under:

The MIT (X11) License