group_custom_emoji
Gets or lists a group_custom_emoji resource.
Overview​
| Name | group_custom_emoji |
| Type | Resource |
| Id | gitlab.groups.group_custom_emoji |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the emoji. |
name | string | Name of the emoji. |
created_at | string | Timestamp of when the custom emoji was created. |
external | boolean | Whether the emoji is an external link. |
url | string | Link to file of the emoji. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | include_ancestor_groups | Custom emoji in this namespace. Generated from the GitLab GraphQL schema field Group.customEmoji (connection of CustomEmoji nodes). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the group, for example gitlab-org |
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
include_ancestor_groups | boolean | Includes custom emoji from parent groups. |
SELECT examples​
- list
Custom emoji in this namespace. Generated from the GitLab GraphQL schema field Group.customEmoji (connection of CustomEmoji nodes).
SELECT
id,
name,
created_at,
external,
url
FROM gitlab.groups.group_custom_emoji
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND include_ancestor_groups = '{{ include_ancestor_groups }}'
;