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

Inherits:

Base

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

Defined in:

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

Instance Method Summary

• #channel ⇒ String

  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 ⇒ Boolean^?

  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 ⇒ Boolean^?

  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, #initialize, #to_h, validates

Constructor Details

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

Instance Method Details

#channel ⇒ String

Returns Channel name. One of nick_to or channel needs to be set. When both are set, the message will be sent to both of them.

Returns:

• (String) —

  Channel name. One of nick_to or channel needs to be set. When both are set, the message will be sent to both of them.

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

attribute :channel

#color ⇒ :none, ...

Returns Text color for the message. (“none” is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not “none”). Added 11 more colors in version 2.0.

Returns:

• (:none, :white, :black, :blue, :green, :red, :brown, :purple, :orange, :yellow, :light_green, :teal, :light_cyan, :light_blue, :pink, :gray, :light_gray, nil) —

  Text color for the message. (“none” is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not “none”). Added 11 more colors in version 2.0.

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

attribute :color

#key ⇒ Object^?

Returns Channel key.

Returns:

• (Object, nil) —

  Channel key

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

attribute :key

#msg ⇒ String

Returns The message body.

Returns:

• (String) —

  The message body.

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

attribute :msg

#nick ⇒ String^?

Returns Nickname to send the message from. May be shortened, depending on server’s NICKLEN setting.

Returns:

• (String, nil) —

  Nickname to send the message from. May be shortened, depending on server’s NICKLEN setting.

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

attribute :nick

#nick_to ⇒ Array<String>, ...

Returns A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them.

Returns:

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

  A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them.

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

attribute :nick_to

#part ⇒ Boolean^?

Returns Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages.

Returns:

• (Boolean, nil) —

  Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages.

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

attribute :part

#passwd ⇒ Object^?

Returns Server password.

Returns:

• (Object, nil) —

  Server password

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

attribute :passwd

#port ⇒ Integer^?

Returns IRC server port number.

Returns:

• (Integer, nil) —

  IRC server port number

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

attribute :port

#server ⇒ String^?

Returns IRC server name/address.

Returns:

• (String, nil) —

  IRC server name/address

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

attribute :server

#style ⇒ :bold, ...

Returns Text style for the message. Note italic does not work on some clients.

Returns:

• (:bold, :underline, :reverse, :italic, nil) —

  Text style for the message. Note italic does not work on some clients

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

attribute :style

#timeout ⇒ Integer^?

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

Returns:

• (Integer, nil) —

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

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

attribute :timeout

#topic ⇒ Object^?

Returns Set the channel topic.

Returns:

• (Object, nil) —

  Set the channel topic

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

attribute :topic

#use_ssl ⇒ Boolean^?

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

Returns:

• (Boolean, nil) —

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

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

attribute :use_ssl