Class: SlackWebApi::Prefs1

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/slack_web_api/models/prefs1.rb

Overview

Prefs1 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(can_thread: SKIP, who_can_post: SKIP, additional_properties: nil) ⇒ Prefs1

Returns a new instance of Prefs1.



41
42
43
44
45
46
47
48
49
 
# File 'lib/slack_web_api/models/prefs1.rb', line 41

def initialize(can_thread: SKIP, who_can_post: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @can_thread = can_thread unless can_thread == SKIP
  @who_can_post = who_can_post unless who_can_post == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#can_thread ⇒ CanThread

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/slack_web_api/models/prefs1.rb', line 14

def can_thread
  @can_thread
end

#who_can_post ⇒ WhoCanPost

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/slack_web_api/models/prefs1.rb', line 18

def who_can_post
  @who_can_post
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/slack_web_api/models/prefs1.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  can_thread = CanThread.from_hash(hash['can_thread']) if hash['can_thread']
  who_can_post = WhoCanPost.from_hash(hash['who_can_post']) if hash['who_can_post']

  # Create a new hash for additional properties, removing known properties.

  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.

  Prefs1.new(can_thread: can_thread,
             who_can_post: who_can_post,
             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/slack_web_api/models/prefs1.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['can_thread'] = 'can_thread'
  @_hash['who_can_post'] = 'who_can_post'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/slack_web_api/models/prefs1.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/slack_web_api/models/prefs1.rb', line 29

def self.optionals
  %w[
    can_thread
    who_can_post
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/slack_web_api/models/prefs1.rb', line 80

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} can_thread: #{@can_thread.inspect}, who_can_post: #{@who_can_post.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/slack_web_api/models/prefs1.rb', line 73

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} can_thread: #{@can_thread}, who_can_post: #{@who_can_post},"\
  " additional_properties: #{@additional_properties}>"
end