Class: SlackWebApi::ObjsReminder

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

Overview

ObjsReminder 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(creator:, id:, recurring:, text:, user:, complete_ts: SKIP, time: SKIP, additional_properties: nil) ⇒ ObjsReminder

Returns a new instance of ObjsReminder.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 66

def initialize(creator:, id:, recurring:, text:, user:, complete_ts: SKIP,
               time: SKIP, additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @complete_ts = complete_ts unless complete_ts == SKIP
  @creator = creator
  @id = id
  @recurring = recurring
  @text = text
  @time = time unless time == SKIP
  @user = user
  @additional_properties = additional_properties
end

Instance Attribute Details

#complete_ts ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def complete_ts
  @complete_ts
end

#creator ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def creator
  @creator
end

#id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 22

def id
  @id
end

#recurring ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


26
27
28
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 26

def recurring
  @recurring
end

#text ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 30

def text
  @text
end

#time ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 34

def time
  @time
end

#user ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 38

def user
  @user
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 82

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  creator = hash.key?('creator') ? hash['creator'] : nil
  id = hash.key?('id') ? hash['id'] : nil
  recurring = hash.key?('recurring') ? hash['recurring'] : nil
  text = hash.key?('text') ? hash['text'] : nil
  user = hash.key?('user') ? hash['user'] : nil
  complete_ts = hash.key?('complete_ts') ? hash['complete_ts'] : SKIP
  time = hash.key?('time') ? hash['time'] : SKIP

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

  ObjsReminder.new(creator: creator,
                   id: id,
                   recurring: recurring,
                   text: text,
                   user: user,
                   complete_ts: complete_ts,
                   time: time,
                   additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['complete_ts'] = 'complete_ts'
  @_hash['creator'] = 'creator'
  @_hash['id'] = 'id'
  @_hash['recurring'] = 'recurring'
  @_hash['text'] = 'text'
  @_hash['time'] = 'time'
  @_hash['user'] = 'user'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



62
63
64
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 62

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 54

def self.optionals
  %w[
    complete_ts
    time
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



121
122
123
124
125
126
127
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 121

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} complete_ts: #{@complete_ts.inspect}, creator: #{@creator.inspect}, id:"\
  " #{@id.inspect}, recurring: #{@recurring.inspect}, text: #{@text.inspect}, time:"\
  " #{@time.inspect}, user: #{@user.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



113
114
115
116
117
118
 
# File 'lib/slack_web_api/models/objs_reminder.rb', line 113

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} complete_ts: #{@complete_ts}, creator: #{@creator}, id: #{@id}, recurring:"\
  " #{@recurring}, text: #{@text}, time: #{@time}, user: #{@user}, additional_properties:"\
  " #{@additional_properties}>"
end