Class: Ansible::Ruby::Modules::Irc

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/notification/irc.rb

Overview

Send a message to an IRC channel. This is a very simplistic implementation.

Instance Method Summary

• #channel ⇒ NilClass

  Channel name.

• #color ⇒ :none, ...

  Text color for the message.

• #key ⇒ Object^?

  Channel key.

• #msg ⇒ String

  The message body.

• #nick ⇒ String^?

  Nickname to send the message from.

• #nick_to ⇒ Array<String>, ...

  A list of nicknames to send the message to.

• #part ⇒ :yes, ...

  Designates whether user should part from channel after sending message or not.

• #passwd ⇒ Object^?

  Server password.

• #port ⇒ Integer^?

  IRC server port number.

• #server ⇒ String^?

  IRC server name/address.

• #style ⇒ :bold, ...

  Text style for the message.

• #timeout ⇒ Integer^?

  Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop.

• #topic ⇒ Object^?

  Set the channel topic.

• #use_ssl ⇒ :yes, ...

  Designates whether TLS/SSL should be used when connecting to the IRC server.

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

#channel ⇒ NilClass

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

attribute :channel

#color ⇒ :none, ...

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

attribute :color

#key ⇒ Object^?

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

attribute :key

#msg ⇒ String

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

attribute :msg

#nick ⇒ String^?

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

attribute :nick

#nick_to ⇒ Array<String>, ...

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

attribute :nick_to

#part ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/notification/irc.rb', line 57

attribute :part

#passwd ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/irc.rb', line 46

attribute :passwd

#port ⇒ Integer^?

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

attribute :port

#server ⇒ String^?

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

attribute :server

#style ⇒ :bold, ...

# File 'lib/ansible/ruby/modules/generated/notification/irc.rb', line 61

attribute :style

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/notification/irc.rb', line 49

attribute :timeout

#topic ⇒ Object^?

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

attribute :topic

#use_ssl ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/notification/irc.rb', line 53

attribute :use_ssl