Class: Ansible::Ruby::Modules::Hipchat

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb

Overview

Send a message to hipchat

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api ⇒ String?

Returns API url if using a self-hosted hipchat server. For hipchat api version 2 use C(/v2) path in URI.

Returns:

  • (String, nil) —

    API url if using a self-hosted hipchat server. For hipchat api version 2 use C(/v2) path in URI



43
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 43

attribute :api

#color ⇒ :yellow, ...

Returns Background color for the message. Default is yellow.

Returns:

  • (:yellow, :red, :green, :purple, :gray, :random, nil) —

    Background color for the message. Default is yellow.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 27

attribute :color

#from ⇒ String?

Returns Name the message will appear be sent from. max 15 characters. Over 15, will be shorten.

Returns:

  • (String, nil) —

    Name the message will appear be sent from. max 15 characters. Over 15, will be shorten.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 19

attribute :from

#msg ⇒ String

Returns The message body.

Returns:

  • (String) —

    The message body.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 23

attribute :msg

#msg_format ⇒ :text, ...

Returns message format. html or text. Default is text.

Returns:

  • (:text, :html, nil) —

    message format. html or text. Default is text.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 31

attribute :msg_format

#notify ⇒ :yes, ...

Returns notify or not (change the tab color, play a sound, etc).

Returns:

  • (:yes, :no, nil) —

    notify or not (change the tab color, play a sound, etc)



35
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 35

attribute :notify

#room ⇒ String

Returns ID or name of the room.

Returns:

  • (String) —

    ID or name of the room.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 15

attribute :room

#token ⇒ String

Returns API token.

Returns:

  • (String) —

    API token.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 11

attribute :token

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/hipchat.rb', line 39

attribute :validate_certs