|
| 1 | +############ |
| 2 | +Award Emojis |
| 3 | +############ |
| 4 | + |
| 5 | +Reference |
| 6 | +--------- |
| 7 | + |
| 8 | +* v4 API: |
| 9 | + |
| 10 | + +:class:`gitlab.v4.objects.ProjectIssueAwardEmoji` |
| 11 | + +:class:`gitlab.v4.objects.ProjectIssueNoteAwardEmoji` |
| 12 | + +:class:`gitlab.v4.objects.ProjectMergeRequestAwardEmoji` |
| 13 | + +:class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmoji` |
| 14 | + +:class:`gitlab.v4.objects.ProjectSnippetAwardEmoji` |
| 15 | + +:class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmoji` |
| 16 | + +:class:`gitlab.v4.objects.ProjectIssueAwardEmojiManager` |
| 17 | + +:class:`gitlab.v4.objects.ProjectIssueNoteAwardEmojiManager` |
| 18 | + +:class:`gitlab.v4.objects.ProjectMergeRequestAwardEmojiManager` |
| 19 | + +:class:`gitlab.v4.objects.ProjectMergeRequestNoteAwardEmojiManager` |
| 20 | + +:class:`gitlab.v4.objects.ProjectSnippetAwardEmojiManager` |
| 21 | + +:class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager` |
| 22 | + |
| 23 | + |
| 24 | +* GitLab API: https://docs.gitlab.com/ce/api/award_emoji.html |
| 25 | + |
| 26 | +Examples |
| 27 | +-------- |
| 28 | + |
| 29 | +List emojis for a resource:: |
| 30 | + |
| 31 | + emojis = obj.awardemojis.list() |
| 32 | + |
| 33 | +Get a single emoji:: |
| 34 | + |
| 35 | + emoji = obj.awardemojis.get(emoji_id) |
| 36 | + |
| 37 | +Add (create) an emoji:: |
| 38 | + |
| 39 | + emoji = obj.awardemojis.create({'name': 'tractor'}) |
| 40 | + |
| 41 | +Delete an emoji:: |
| 42 | + |
| 43 | + emoji.delete |
| 44 | + # or |
| 45 | + obj.awardemojis.delete(emoji_id) |
