-
-
Notifications
You must be signed in to change notification settings - Fork 287
/
VariantEmoji.kt
58 lines (52 loc) · 1.73 KB
/
VariantEmoji.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
* Copyright (C) 2016 - Niklas Baudy, Ruben Gees, Mario Đanić and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.vanniktech.emoji.variant
import com.vanniktech.emoji.Emoji
/**
* Interface for providing some custom implementation for variant emojis.
*
* @since 0.5.0
*/
interface VariantEmoji {
/**
* Returns the variant for the passed emoji that should be displayed as a preview.
* Could be loaded from a database, shared preferences or just hard coded.
*
* [desiredEmoji] The emoji to retrieve the variant for. If none is found, [desiredEmoji] should be returned.
* @since 0.5.0
*/
fun getVariant(desiredEmoji: Emoji): Emoji
/**
* Return the supported variants for the given [emoji].
* In contrast to [getVariant], this defines whether an overlay to pick a Variant will be shown or not.
* @since 0.20.0
*/
fun getVariants(emoji: Emoji): List<Emoji>
/**
* Should add the emoji to the variants. After calling this method, [getVariant]
* should return the emoji that was just added.
*
* [newVariant] The new variant to save.
* @since 0.5.0
*/
fun addVariant(newVariant: Emoji)
/**
* Should persist all emojis.
*
* @since 0.5.0
*/
fun persist()
}