Class: Ansible::Ruby::Modules::Cisco_spark

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/notification/cisco_spark.rb

Overview

Send a message to a Cisco Spark Room or Individual with options to control the formatting.

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

#message ⇒ String

Returns The message you would like to send.

Returns:

  • (String) —

    The message you would like to send.



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

attribute :message

#message_type ⇒ :text, ...

Returns Specifies how you would like the message formatted.

Returns:

  • (:text, :markdown, nil) —

    Specifies how you would like the message formatted.



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

attribute :message_type

#personal_token ⇒ String

Returns Your personal access token required to validate the Spark API.

Returns:

  • (String) —

    Your personal access token required to validate the Spark API.



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

attribute :personal_token

#recipient_id ⇒ String

Returns The unique identifier associated with the supplied C(recipient_type).

Returns:

  • (String) —

    The unique identifier associated with the supplied C(recipient_type).



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

attribute :recipient_id

#recipient_type ⇒ :roomId, ...

Returns The request parameter you would like to send the message to.,Messages can be sent to either a room or individual (by ID or E-Mail).

Returns:

  • (:roomId, :toPersonEmail, :toPersonId) —

    The request parameter you would like to send the message to.,Messages can be sent to either a room or individual (by ID or E-Mail).



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

attribute :recipient_type