Class: OCI::Oda::Models::SlackChannel

Inherits:
Channel
  • Object
show all
Defined in:
lib/oci/oda/models/slack_channel.rb

Overview

The configuration for a Slack channel.

Constant Summary

Constants inherited from Channel

Channel::CATEGORY_ENUM, Channel::LIFECYCLE_STATE_ENUM, Channel::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Channel

#category, #defined_tags, #description, #freeform_tags, #id, #lifecycle_state, #name, #session_expiry_duration_in_milliseconds, #time_created, #time_updated, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Channel

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SlackChannel

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id proprety

  • :name (String)

    The value to assign to the #name proprety

  • :description (String)

    The value to assign to the #description proprety

  • :category (String)

    The value to assign to the #category proprety

  • :session_expiry_duration_in_milliseconds (Integer)

    The value to assign to the #session_expiry_duration_in_milliseconds proprety

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state proprety

  • :time_created (DateTime)

    The value to assign to the #time_created proprety

  • :time_updated (DateTime)

    The value to assign to the #time_updated proprety

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags proprety

  • :client_id (String)

    The value to assign to the #client_id property

  • :auth_success_url (String)

    The value to assign to the #auth_success_url property

  • :auth_error_url (String)

    The value to assign to the #auth_error_url property

  • :bot_id (String)

    The value to assign to the #bot_id property

  • :webhook_url (String)

    The value to assign to the #webhook_url property



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/oci/oda/models/slack_channel.rb', line 103

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'SLACK'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

  raise 'You cannot provide both :clientId and :client_id' if attributes.key?(:'clientId') && attributes.key?(:'client_id')

  self.client_id = attributes[:'client_id'] if attributes[:'client_id']

  self.auth_success_url = attributes[:'authSuccessUrl'] if attributes[:'authSuccessUrl']

  raise 'You cannot provide both :authSuccessUrl and :auth_success_url' if attributes.key?(:'authSuccessUrl') && attributes.key?(:'auth_success_url')

  self.auth_success_url = attributes[:'auth_success_url'] if attributes[:'auth_success_url']

  self.auth_error_url = attributes[:'authErrorUrl'] if attributes[:'authErrorUrl']

  raise 'You cannot provide both :authErrorUrl and :auth_error_url' if attributes.key?(:'authErrorUrl') && attributes.key?(:'auth_error_url')

  self.auth_error_url = attributes[:'auth_error_url'] if attributes[:'auth_error_url']

  self.bot_id = attributes[:'botId'] if attributes[:'botId']

  raise 'You cannot provide both :botId and :bot_id' if attributes.key?(:'botId') && attributes.key?(:'bot_id')

  self.bot_id = attributes[:'bot_id'] if attributes[:'bot_id']

  self.webhook_url = attributes[:'webhookUrl'] if attributes[:'webhookUrl']

  raise 'You cannot provide both :webhookUrl and :webhook_url' if attributes.key?(:'webhookUrl') && attributes.key?(:'webhook_url')

  self.webhook_url = attributes[:'webhook_url'] if attributes[:'webhook_url']
end

Instance Attribute Details

#auth_error_urlString

The URL to redirect to when authentication is unsuccessful.

Returns:

  • (String)


22
23
24
# File 'lib/oci/oda/models/slack_channel.rb', line 22

def auth_error_url
  @auth_error_url
end

#auth_success_urlString

The URL to redirect to when authentication is successful.

Returns:

  • (String)


18
19
20
# File 'lib/oci/oda/models/slack_channel.rb', line 18

def auth_success_url
  @auth_success_url
end

#bot_idString

The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:

  • (String)


26
27
28
# File 'lib/oci/oda/models/slack_channel.rb', line 26

def bot_id
  @bot_id
end

#client_idString

[Required] The Slack Client Id for the Slack app.

Returns:

  • (String)


14
15
16
# File 'lib/oci/oda/models/slack_channel.rb', line 14

def client_id
  @client_id
end

#webhook_urlString

[Required] The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.

Returns:

  • (String)


32
33
34
# File 'lib/oci/oda/models/slack_channel.rb', line 32

def webhook_url
  @webhook_url
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/oci/oda/models/slack_channel.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'category': :'category',
    'type': :'type',
    'session_expiry_duration_in_milliseconds': :'sessionExpiryDurationInMilliseconds',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'client_id': :'clientId',
    'auth_success_url': :'authSuccessUrl',
    'auth_error_url': :'authErrorUrl',
    'bot_id': :'botId',
    'webhook_url': :'webhookUrl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/oci/oda/models/slack_channel.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'category': :'String',
    'type': :'String',
    'session_expiry_duration_in_milliseconds': :'Integer',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'client_id': :'String',
    'auth_success_url': :'String',
    'auth_error_url': :'String',
    'bot_id': :'String',
    'webhook_url': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/oci/oda/models/slack_channel.rb', line 151

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    category == other.category &&
    type == other.type &&
    session_expiry_duration_in_milliseconds == other.session_expiry_duration_in_milliseconds &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    client_id == other.client_id &&
    auth_success_url == other.auth_success_url &&
    auth_error_url == other.auth_error_url &&
    bot_id == other.bot_id &&
    webhook_url == other.webhook_url
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/oci/oda/models/slack_channel.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
# File 'lib/oci/oda/models/slack_channel.rb', line 176

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



185
186
187
# File 'lib/oci/oda/models/slack_channel.rb', line 185

def hash
  [id, name, description, category, type, session_expiry_duration_in_milliseconds, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags, client_id, auth_success_url, auth_error_url, bot_id, webhook_url].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
# File 'lib/oci/oda/models/slack_channel.rb', line 229

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



223
224
225
# File 'lib/oci/oda/models/slack_channel.rb', line 223

def to_s
  to_hash.to_s
end