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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Rocketchat

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

• #attachments ⇒ Array<Hash>, ...

  Define a list of attachments.

• #channel ⇒ NilClass^?

  Channel to send the message to.

• #color ⇒ :normal, ...

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

• #domain ⇒ String

  The domain for your environment without protocol.

• #icon_emoji ⇒ Object^?

  Emoji for the message sender.

• #icon_url ⇒ String^?

  URL for the message sender’s icon.

• #link_names ⇒ 1, ...

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

• #msg ⇒ String^?

  Message to be sent.

• #protocol ⇒ :http, ...

  Specify the protocol used to send notification messages before the webhook url.

• #token ⇒ String

  Rocket Chat Incoming Webhook integration token.

• #username ⇒ String^?

  This is the sender of the message.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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>, ...

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

attribute :attachments

#channel ⇒ NilClass^?

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

attribute :channel

#color ⇒ :normal, ...

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

attribute :color

#domain ⇒ String

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

attribute :domain

#icon_emoji ⇒ Object^?

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

attribute :icon_emoji

#icon_url ⇒ String^?

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

attribute :icon_url

#link_names ⇒ 1, ...

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

attribute :link_names

#msg ⇒ String^?

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

attribute :msg

#protocol ⇒ :http, ...

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

attribute :protocol

#token ⇒ String

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

attribute :token

#username ⇒ String^?

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

attribute :username

#validate_certs ⇒ :yes, ...

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

attribute :validate_certs