GraphQLでカスタム絵文字を使用

  • GitLab 13.6 でcustom_emojiというフラグで導入されました。デフォルトでは無効になっています。
  • GitLab 14.0でGitLab.comで有効に。

フラグ: セルフマネジメントの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エクスプローラーは以下の用途に使用できます:

  1. 以下のコードをコピーしてください:
    query GetCustomEmoji {
      group(fullPath: "gitlab-org") {
        id
        customEmoji {
          nodes {
            name,
            url
          }
        }
      }
    }
  1. GraphiQLエクスプローラーツールを開きます。
  2. GraphiQL エクスプローラー ツールの左ウィンドウに上記のquery を貼り付けます。
  3. 再生」を選択すると、このような結果が得られます:

GraphiQL explore custom emoji query

詳細については