Method: Gitlab::Client::BroadcastMessages#edit_broadcast_message

Defined in:

lib/gitlab/client/broadcast_messages.rb

#edit_broadcast_message(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Update a broadcast message

Examples:

Gitlab.edit_broadcast_message(6, { message: 'No Mayday' })
Gitlab.edit_broadcast_message(6, { font: '#FEFEFE' })

Parameters:

• id (Integer) —

  The ID of a broadcast message

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :message(optional) (String) —

  Message to display

• :starts_at(optional) (DateTime) —

  Starting time (defaults to current time)

• :ends_at(optional) (DateTime) —

  Ending time (defaults to one hour from current time)

• :color(optional) (String) —

  Background color hex code

• :font(optional) (String) —

  Foreground color hex code

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about updated broadcast message.

# File 'lib/gitlab/client/broadcast_messages.rb', line 60

def edit_broadcast_message(id, options = {})
  put("/broadcast_messages/#{id}", body: options)
end