Class: Ansible::Ruby::Modules::Rocketchat

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

Overview

The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration

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

#attachments ⇒ Array<Hash>, ...

Returns Define a list of attachments.

Returns:

  • (Array<Hash>, Hash, nil) —

    Define a list of attachments.



55
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 55

attribute :attachments

#channel ⇒ NilClass?

Returns Channel to send the message to. If absent, the message goes to the channel selected for the I(token) specified during the creation of webhook.

Returns:

  • (NilClass, nil) —

    Channel to send the message to. If absent, the message goes to the channel selected for the I(token) specified during the creation of webhook.



28
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 28

attribute :channel

#color ⇒ :normal, ...

Returns Allow text to use default colors - use the default of ‘normal’ to not send a custom color bar at the start of the message.

Returns:

  • (:normal, :good, :warning, :danger, nil) —

    Allow text to use default colors - use the default of ‘normal’ to not send a custom color bar at the start of the message



51
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 51

attribute :color

#domain ⇒ String

Returns The domain for your environment without protocol. (i.e. C(example.com) or C(chat.example.com)).

Returns:

  • (String) —

    The domain for your environment without protocol. (i.e. C(example.com) or C(chat.example.com))



12
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 12

attribute :domain

#icon_emoji ⇒ Object?

Returns Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used).

Returns:

  • (Object, nil) —

    Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used)



40
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 40

attribute :icon_emoji

#icon_url ⇒ String?

Returns URL for the message sender’s icon.

Returns:

  • (String, nil) —

    URL for the message sender’s icon.



36
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 36

attribute :icon_url

#link_names ⇒ 1, ...

Returns Automatically create links for channels and usernames in I(msg).

Returns:

  • (1, 0, nil) —

    Automatically create links for channels and usernames in I(msg).



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

attribute :link_names

#msg ⇒ String?

Returns Message to be sent.

Returns:

  • (String, nil) —

    Message to be sent.



24
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 24

attribute :msg

#protocol ⇒ :http, ...

Returns Specify the protocol used to send notification messages before the webhook url. (i.e. http or https).

Returns:

  • (:http, :https, nil) —

    Specify the protocol used to send notification messages before the webhook url. (i.e. http or https)



20
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 20

attribute :protocol

#token ⇒ String

Returns Rocket Chat Incoming Webhook integration token. This provides authentication to Rocket Chat’s Incoming webhook for posting messages.

Returns:

  • (String) —

    Rocket Chat Incoming Webhook integration token. This provides authentication to Rocket Chat’s Incoming webhook for posting messages.



16
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 16

attribute :token

#username ⇒ String?

Returns This is the sender of the message.

Returns:

  • (String, nil) —

    This is the sender of the message.



32
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 32

attribute :username

#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.



47
 
# File 'lib/ansible/ruby/modules/generated/notification/rocketchat.rb', line 47

attribute :validate_certs