Class: Ansible::Ruby::Modules::Flowdock

Inherits:

Base

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

Defined in:

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

Overview

Send a message to a flowdock team inbox or chat using the push API (see www.flowdock.com/api/team-inbox and www.flowdock.com/api/chat)

Instance Method Summary

• #external_user_name ⇒ String^?

  (chat only - required) Name of the “user” sending the message.

• #from_address ⇒ String^?

  (inbox only - required) Email address of the message sender.

• #from_name ⇒ Object^?

  (inbox only) Name of the message sender.

• #link ⇒ Object^?

  (inbox only) Link associated with the message.

• #msg ⇒ String

  Content of the message.

• #project ⇒ Object^?

  (inbox only) Human readable identifier for more detailed message categorization.

• #reply_to ⇒ Object^?

  (inbox only) Email address for replies.

• #source ⇒ String^?

  (inbox only - required) Human readable identifier of the application that uses the Flowdock API.

• #subject ⇒ String^?

  (inbox only - required) Subject line of the message.

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

  Tags of the message, separated by commas.

• #token ⇒ String

  API token.

• #type ⇒ :inbox, :chat

  Whether to post to ‘inbox’ or ‘chat’.

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

Constructor Details

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

Instance Method Details

#external_user_name ⇒ String^?

Returns (chat only - required) Name of the “user” sending the message.

Returns:

• (String, nil) —

  (chat only - required) Name of the “user” sending the message

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 27

attribute :external_user_name

#from_address ⇒ String^?

Returns (inbox only - required) Email address of the message sender.

Returns:

• (String, nil) —

  (inbox only - required) Email address of the message sender

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

attribute :from_address

#from_name ⇒ Object^?

Returns (inbox only) Name of the message sender.

Returns:

• (Object, nil) —

  (inbox only) Name of the message sender

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

attribute :from_name

#link ⇒ Object^?

Returns (inbox only) Link associated with the message. This will be used to link the message subject in Team Inbox.

Returns:

• (Object, nil) —

  (inbox only) Link associated with the message. This will be used to link the message subject in Team Inbox.

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 52

attribute :link

#msg ⇒ String

Returns Content of the message.

Returns:

• (String) —

  Content of the message

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 19

attribute :msg

#project ⇒ Object^?

Returns (inbox only) Human readable identifier for more detailed message categorization.

Returns:

• (Object, nil) —

  (inbox only) Human readable identifier for more detailed message categorization

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

attribute :project

#reply_to ⇒ Object^?

Returns (inbox only) Email address for replies.

Returns:

• (Object, nil) —

  (inbox only) Email address for replies

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

attribute :reply_to

#source ⇒ String^?

Returns (inbox only - required) Human readable identifier of the application that uses the Flowdock API.

Returns:

• (String, nil) —

  (inbox only - required) Human readable identifier of the application that uses the Flowdock API

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

attribute :source

#subject ⇒ String^?

Returns (inbox only - required) Subject line of the message.

Returns:

• (String, nil) —

  (inbox only - required) Subject line of the message

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

attribute :subject

#tags ⇒ Array<String>, ...

Returns tags of the message, separated by commas.

Returns:

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

  tags of the message, separated by commas

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 23

attribute :tags

#token ⇒ String

Returns API token.

Returns:

• (String) —

  API token.

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 11

attribute :token

#type ⇒ :inbox, :chat

Returns Whether to post to ‘inbox’ or ‘chat’.

Returns:

• (:inbox, :chat) —

  Whether to post to ‘inbox’ or ‘chat’

# File 'lib/ansible/ruby/modules/generated/extras/notification/flowdock.rb', line 15

attribute :type

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

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

attribute :validate_certs