Contents

# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to avatar.
  # @see https://docs.gitlab.com/ce/api/avatar.html
  module Avatar
    # Get a single avatar URL for a user with the given email address.
    #
    # @example
    #   Gitlab.avatar(email: '[e-mail]')
    #   Gitlab.avatar(email: '[e-mail]', size: 32)
    #
    # @param  [Hash] options A customizable set of options.
    # @option options [String] :email(required) Public email address of the user.
    # @option options [Integer] :size(optional) Single pixel dimension (since images are squares). Only used for avatar lookups at Gravatar or at the configured Libravatar server.
    # @return <Gitlab::ObjectifiedHash>
    def avatar(options = {})
      get('/avatar', query: options)
    end
  end
end

Version data entries

22 entries across 22 versions & 2 rubygems

Version	Path
gitlab-4.11.0	lib/gitlab/client/avatar.rb
gitlab-4.10.0	lib/gitlab/client/avatar.rb