module Gitlab::Client::Events

Defines methods related to events. @see docs.gitlab.com/ce/api/events.html

Public Instance Methods

events(options = {}) click to toggle source

Gets a list of authenticated user’s events

@example

Gitlab.events()
Gitlab.events({ action: 'created', target_type: 'issue' })

@param [Hash] options A customizable set of options. @option options [String] :action Only events of specific action type @option options [String] :target_type Only events of specific target type @option options [String] :before Only events created before YYYY-MM-DD @option options [String] :after Only events created after YYYY-MM-DD @option options [String] :sort Sort by created_at either ‘asc’ or ‘desc’ @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/events.rb, line 20
def events(options = {})
  get('/events', query: options)
end
project_events(project, options = {}) click to toggle source

Gets a list of visible project events

@example

Gitlab.project_events(1)
Gitlab.project_events(1, { action: created })

@param [Integer] project The ID of project @param [Hash] options A customizable set of options. @option options [String] :action Only events of specific action type @option options [String] :target_type Only events of specific target type @option options [String] :before Only events created before YYYY-MM-DD @option options [String] :after Only events created after YYYY-MM-DD @option options [String] :sort Sort by created_at either ‘asc’ or ‘desc’ @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/events.rb, line 56
def project_events(project, options = {})
  get("/projects/#{url_encode project}/events", query: options)
end
user_events(user, options = {}) click to toggle source

Gets a list of user contribution events

@example

Gitlab.user_events(1)
Gitlab.user_events(1, { action: created})

@param [Integer, String] user The ID or username of user @param [Hash] options A customizable set of options. @option options [String] :action Only events of specific action type @option options [String] :target_type Only events of specific target type @option options [String] :before Only events created before YYYY-MM-DD @option options [String] :after Only events created after YYYY-MM-DD @option options [String] :sort Sort by created_at either ‘asc’ or ‘desc’ @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/events.rb, line 38
def user_events(user, options = {})
  get("/users/#{url_encode user}/events", query: options)
end