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

Inherits:
Base show all
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 collapse

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

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:

  • (NilClass) —

    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.



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

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.



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

attribute :color

#key ⇒ Object?

Returns Channel key.

Returns:

  • (Object, nil) —

    Channel key



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

attribute :key

#msg ⇒ String

Returns The message body.

Returns:

  • (String) —

    The message body.



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

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.



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

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.



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

attribute :nick_to

#part ⇒ :yes, ...

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:

  • (:yes, :no, 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.



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

attribute :part

#passwd ⇒ Object?

Returns Server password.

Returns:

  • (Object, nil) —

    Server password



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

attribute :passwd

#port ⇒ Integer?

Returns IRC server port number.

Returns:

  • (Integer, nil) —

    IRC server port number



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

attribute :port

#server ⇒ String?

Returns IRC server name/address.

Returns:

  • (String, nil) —

    IRC server name/address



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

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



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

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



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

attribute :timeout

#topic ⇒ Object?

Returns Set the channel topic.

Returns:

  • (Object, nil) —

    Set the channel topic



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

attribute :topic

#use_ssl ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :use_ssl