GraphQLでカスタム絵文字を使用
フラグ: セルフマネジメントのGitLabでは、デフォルトではこの機能は利用できません。利用可能にするには、管理者がcustom_emoji
という機能フラグを有効にします。GitLab.comでは、この機能は利用可能です。この機能は本番環境でも利用可能です。
コメントや説明文にカスタム絵文字を使うには、GraphQL APIを使ってトップレベルのグループに追加します。
パラメータを指定します:
属性 | 種類 | 必須 | 説明 |
---|---|---|---|
group_path | 整数/文字列 | {チェックサークル}はい | トップレベルグループのIDまたはURLエンコードされたパス |
name | 文字列です。 | {チェックサークル}はい | カスタム絵文字の名前。 |
file | 文字列です。 | {チェックサークル}はい | カスタム絵文字画像のURL。 |
カスタム絵文字の作成
mutation CreateCustomEmoji($groupPath: ID!) {
createCustomEmoji(input: {groupPath: $groupPath, name: "party-parrot", url: "https://cultofthepartyparrot.com/parrots/hd/parrot.gif"}) {
clientMutationId
customEmoji {
name
}
errors
}
}
グループにカスタム絵文字を追加すると、メンバーはコメントで他の絵文字と同じように使うことができます。
グループのカスタム絵文字を取得
query GetCustomEmoji($groupPath: ID!) {
group(fullPath: $groupPath) {
id
customEmoji {
nodes {
name
}
}
}
}
GraphiQLエクスプローラの設定
この手順では、GraphiQLエクスプローラーにコピー&ペーストできる実質的な例を示します。GraphiQLエクスプローラーは以下の用途に使用できます:
- GitLab.comユーザーhttps://gitlab.com/-/graphql-explorer。
- 自己管理ユーザー
https://gitlab.example.com/-/graphql-explorer
。
- 以下のコードをコピーしてください:
query GetCustomEmoji {
group(fullPath: "gitlab-org") {
id
customEmoji {
nodes {
name,
url
}
}
}
}
- GraphiQLエクスプローラーツールを開きます。
- GraphiQL エクスプローラー ツールの左ウィンドウに上記の
query
を貼り付けます。 - 再生」を選択すると、このような結果が得られます:
詳細については
- フラグメントやインターフェースなどのGraphQL固有のエンティティについては、GraphQLの公式ドキュメントを参照してください。
- 個々の属性については、GraphQL APIリソースを参照してください。