Class: SlackWebApi::ScheduledMessage

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

Overview

ScheduledMessage 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(channel_id:, date_created:, id:, post_at:, text: SKIP, additional_properties: nil) ⇒ ScheduledMessage 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 55

def initialize(channel_id:, date_created:, id:, post_at:, text: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @channel_id = channel_id
  @date_created = date_created
  @id = id
  @post_at = post_at
  @text = text unless text == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#channel_id ⇒ String

TODO: Write general description for this method



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

def channel_id
  @channel_id
end

#date_created ⇒ Integer

TODO: Write general description for this method



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

def date_created
  @date_created
end

#id ⇒ String

TODO: Write general description for this method



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

def id
  @id
end

#post_at ⇒ Integer

TODO: Write general description for this method



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

def post_at
  @post_at
end

#text ⇒ String

TODO: Write general description for this method



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

def text
  @text
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 69

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channel_id = hash.key?('channel_id') ? hash['channel_id'] : nil
  date_created = hash.key?('date_created') ? hash['date_created'] : nil
  id = hash.key?('id') ? hash['id'] : nil
  post_at = hash.key?('post_at') ? hash['post_at'] : nil
  text = hash.key?('text') ? hash['text'] : 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.

  ScheduledMessage.new(channel_id: channel_id,
                       date_created: date_created,
                       id: id,
                       post_at: post_at,
                       text: text,
                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channel_id'] = 'channel_id'
  @_hash['date_created'] = 'date_created'
  @_hash['id'] = 'id'
  @_hash['post_at'] = 'post_at'
  @_hash['text'] = 'text'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



51
52
53
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 51

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 44

def self.optionals
  %w[
    text
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



103
104
105
106
107
108
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 103

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} channel_id: #{@channel_id.inspect}, date_created: #{@date_created.inspect},"\
  " id: #{@id.inspect}, post_at: #{@post_at.inspect}, text: #{@text.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



96
97
98
99
100
 
# File 'lib/slack_web_api/models/scheduled_message.rb', line 96

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} channel_id: #{@channel_id}, date_created: #{@date_created}, id: #{@id},"\
  " post_at: #{@post_at}, text: #{@text}, additional_properties: #{@additional_properties}>"
end