Class: SlackWebApi::ChatScheduleMessageSuccessSchema

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

Overview

Schema for successful response of chat.scheduleMessage method

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:, message:, post_at:, scheduled_message_id:, additional_properties: nil) ⇒ ChatScheduleMessageSuccessSchema

Returns a new instance of ChatScheduleMessageSuccessSchema.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/slack_web_api/models/chat_schedule_message_success_schema.rb', line 53

def initialize(channel:, message:, post_at:, scheduled_message_id:,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @channel = channel
  @message = message
  @ok = 'True'
  @post_at = post_at
  @scheduled_message_id = scheduled_message_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#channel ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def channel
  @channel
end

#message ⇒ Message

TODO: Write general description for this method

Returns:



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

def message
  @message
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#post_at ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def post_at
  @post_at
end

#scheduled_message_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def scheduled_message_id
  @scheduled_message_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channel = hash.key?('channel') ? hash['channel'] : nil
  message = Message.from_hash(hash['message']) if hash['message']
  post_at = hash.key?('post_at') ? hash['post_at'] : nil
  scheduled_message_id =
    hash.key?('scheduled_message_id') ? hash['scheduled_message_id'] : nil

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

  ChatScheduleMessageSuccessSchema.new(channel: channel,
                                       message: message,
                                       post_at: post_at,
                                       scheduled_message_id: scheduled_message_id,
                                       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/chat_schedule_message_success_schema.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channel'] = 'channel'
  @_hash['message'] = 'message'
  @_hash['ok'] = 'ok'
  @_hash['post_at'] = 'post_at'
  @_hash['scheduled_message_id'] = 'scheduled_message_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/slack_web_api/models/chat_schedule_message_success_schema.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
 
# File 'lib/slack_web_api/models/chat_schedule_message_success_schema.rb', line 44

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



101
102
103
104
105
106
 
# File 'lib/slack_web_api/models/chat_schedule_message_success_schema.rb', line 101

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} channel: #{@channel.inspect}, message: #{@message.inspect}, ok:"\
  " #{@ok.inspect}, post_at: #{@post_at.inspect}, scheduled_message_id:"\
  " #{@scheduled_message_id.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
98
 
# File 'lib/slack_web_api/models/chat_schedule_message_success_schema.rb', line 93

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} channel: #{@channel}, message: #{@message}, ok: #{@ok}, post_at:"\
  " #{@post_at}, scheduled_message_id: #{@scheduled_message_id}, additional_properties:"\
  " #{@additional_properties}>"
end