Class: SlackWebApi::FileObject

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

Overview

FileObject 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(channels: SKIP, comments_count: SKIP, created: SKIP, date_delete: SKIP, display_as_bot: SKIP, editable: SKIP, editor: SKIP, external_id: SKIP, external_type: SKIP, external_url: SKIP, filetype: SKIP, groups: SKIP, has_rich_preview: SKIP, id: SKIP, image_exif_rotation: SKIP, ims: SKIP, is_external: SKIP, is_public: SKIP, is_starred: SKIP, is_tombstoned: SKIP, last_editor: SKIP, mimetype: SKIP, mode: SKIP, name: SKIP, non_owner_editable: SKIP, num_stars: SKIP, original_h: SKIP, original_w: SKIP, permalink: SKIP, permalink_public: SKIP, pinned_info: SKIP, pinned_to: SKIP, pretty_type: SKIP, preview: SKIP, public_url_shared: SKIP, reactions: SKIP, shares: SKIP, size: SKIP, source_team: SKIP, state: SKIP, thumb_1024: SKIP, thumb_1024_h: SKIP, thumb_1024_w: SKIP, thumb_160: SKIP, thumb_360: SKIP, thumb_360_h: SKIP, thumb_360_w: SKIP, thumb_480: SKIP, thumb_480_h: SKIP, thumb_480_w: SKIP, thumb_64: SKIP, thumb_720: SKIP, thumb_720_h: SKIP, thumb_720_w: SKIP, thumb_80: SKIP, thumb_800: SKIP, thumb_800_h: SKIP, thumb_800_w: SKIP, thumb_960: SKIP, thumb_960_h: SKIP, thumb_960_w: SKIP, thumb_tiny: SKIP, timestamp: SKIP, title: SKIP, updated: SKIP, url_private: SKIP, url_private_download: SKIP, user: SKIP, user_team: SKIP, username: SKIP, additional_properties: nil) ⇒ FileObject

Returns a new instance of FileObject.



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/slack_web_api/models/file_object.rb', line 449

def initialize(channels: SKIP, comments_count: SKIP, created: SKIP,
               date_delete: SKIP, display_as_bot: SKIP, editable: SKIP,
               editor: SKIP, external_id: SKIP, external_type: SKIP,
               external_url: SKIP, filetype: SKIP, groups: SKIP,
               has_rich_preview: SKIP, id: SKIP, image_exif_rotation: SKIP,
               ims: SKIP, is_external: SKIP, is_public: SKIP,
               is_starred: SKIP, is_tombstoned: SKIP, last_editor: SKIP,
               mimetype: SKIP, mode: SKIP, name: SKIP,
               non_owner_editable: SKIP, num_stars: SKIP, original_h: SKIP,
               original_w: SKIP, permalink: SKIP, permalink_public: SKIP,
               pinned_info: SKIP, pinned_to: SKIP, pretty_type: SKIP,
               preview: SKIP, public_url_shared: SKIP, reactions: SKIP,
               shares: SKIP, size: SKIP, source_team: SKIP, state: SKIP,
               thumb_1024: SKIP, thumb_1024_h: SKIP, thumb_1024_w: SKIP,
               thumb_160: SKIP, thumb_360: SKIP, thumb_360_h: SKIP,
               thumb_360_w: SKIP, thumb_480: SKIP, thumb_480_h: SKIP,
               thumb_480_w: SKIP, thumb_64: SKIP, thumb_720: SKIP,
               thumb_720_h: SKIP, thumb_720_w: SKIP, thumb_80: SKIP,
               thumb_800: SKIP, thumb_800_h: SKIP, thumb_800_w: SKIP,
               thumb_960: SKIP, thumb_960_h: SKIP, thumb_960_w: SKIP,
               thumb_tiny: SKIP, timestamp: SKIP, title: SKIP,
               updated: SKIP, url_private: SKIP, url_private_download: SKIP,
               user: SKIP, user_team: SKIP, username: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @channels = channels unless channels == SKIP
  @comments_count = comments_count unless comments_count == SKIP
  @created = created unless created == SKIP
  @date_delete = date_delete unless date_delete == SKIP
  @display_as_bot = display_as_bot unless display_as_bot == SKIP
  @editable = editable unless editable == SKIP
  @editor = editor unless editor == SKIP
  @external_id = external_id unless external_id == SKIP
  @external_type = external_type unless external_type == SKIP
  @external_url = external_url unless external_url == SKIP
  @filetype = filetype unless filetype == SKIP
  @groups = groups unless groups == SKIP
  @has_rich_preview = has_rich_preview unless has_rich_preview == SKIP
  @id = id unless id == SKIP
  @image_exif_rotation = image_exif_rotation unless image_exif_rotation == SKIP
  @ims = ims unless ims == SKIP
  @is_external = is_external unless is_external == SKIP
  @is_public = is_public unless is_public == SKIP
  @is_starred = is_starred unless is_starred == SKIP
  @is_tombstoned = is_tombstoned unless is_tombstoned == SKIP
  @last_editor = last_editor unless last_editor == SKIP
  @mimetype = mimetype unless mimetype == SKIP
  @mode = mode unless mode == SKIP
  @name = name unless name == SKIP
  @non_owner_editable = non_owner_editable unless non_owner_editable == SKIP
  @num_stars = num_stars unless num_stars == SKIP
  @original_h = original_h unless original_h == SKIP
  @original_w = original_w unless original_w == SKIP
  @permalink = permalink unless permalink == SKIP
  @permalink_public = permalink_public unless permalink_public == SKIP
  @pinned_info = pinned_info unless pinned_info == SKIP
  @pinned_to = pinned_to unless pinned_to == SKIP
  @pretty_type = pretty_type unless pretty_type == SKIP
  @preview = preview unless preview == SKIP
  @public_url_shared = public_url_shared unless public_url_shared == SKIP
  @reactions = reactions unless reactions == SKIP
  @shares = shares unless shares == SKIP
  @size = size unless size == SKIP
  @source_team = source_team unless source_team == SKIP
  @state = state unless state == SKIP
  @thumb_1024 = thumb_1024 unless thumb_1024 == SKIP
  @thumb_1024_h = thumb_1024_h unless thumb_1024_h == SKIP
  @thumb_1024_w = thumb_1024_w unless thumb_1024_w == SKIP
  @thumb_160 = thumb_160 unless thumb_160 == SKIP
  @thumb_360 = thumb_360 unless thumb_360 == SKIP
  @thumb_360_h = thumb_360_h unless thumb_360_h == SKIP
  @thumb_360_w = thumb_360_w unless thumb_360_w == SKIP
  @thumb_480 = thumb_480 unless thumb_480 == SKIP
  @thumb_480_h = thumb_480_h unless thumb_480_h == SKIP
  @thumb_480_w = thumb_480_w unless thumb_480_w == SKIP
  @thumb_64 = thumb_64 unless thumb_64 == SKIP
  @thumb_720 = thumb_720 unless thumb_720 == SKIP
  @thumb_720_h = thumb_720_h unless thumb_720_h == SKIP
  @thumb_720_w = thumb_720_w unless thumb_720_w == SKIP
  @thumb_80 = thumb_80 unless thumb_80 == SKIP
  @thumb_800 = thumb_800 unless thumb_800 == SKIP
  @thumb_800_h = thumb_800_h unless thumb_800_h == SKIP
  @thumb_800_w = thumb_800_w unless thumb_800_w == SKIP
  @thumb_960 = thumb_960 unless thumb_960 == SKIP
  @thumb_960_h = thumb_960_h unless thumb_960_h == SKIP
  @thumb_960_w = thumb_960_w unless thumb_960_w == SKIP
  @thumb_tiny = thumb_tiny unless thumb_tiny == SKIP
  @timestamp = timestamp unless timestamp == SKIP
  @title = title unless title == SKIP
  @updated = updated unless updated == SKIP
  @url_private = url_private unless url_private == SKIP
  @url_private_download = url_private_download unless url_private_download == SKIP
  @user = user unless user == SKIP
  @user_team = user_team unless user_team == SKIP
  @username = username unless username == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#channels ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


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

def channels
  @channels
end

#comments_count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def comments_count
  @comments_count
end

#created ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def created
  @created
end

#date_delete ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def date_delete
  @date_delete
end

#display_as_bot ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def display_as_bot
  @display_as_bot
end

#editable ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def editable
  @editable
end

#editor ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def editor
  @editor
end

#external_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


42
43
44
 
# File 'lib/slack_web_api/models/file_object.rb', line 42

def external_id
  @external_id
end

#external_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


46
47
48
 
# File 'lib/slack_web_api/models/file_object.rb', line 46

def external_type
  @external_type
end

#external_url ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


50
51
52
 
# File 'lib/slack_web_api/models/file_object.rb', line 50

def external_url
  @external_url
end

#filetype ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


54
55
56
 
# File 'lib/slack_web_api/models/file_object.rb', line 54

def filetype
  @filetype
end

#groups ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


58
59
60
 
# File 'lib/slack_web_api/models/file_object.rb', line 58

def groups
  @groups
end

#has_rich_preview ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def has_rich_preview
  @has_rich_preview
end

#id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


66
67
68
 
# File 'lib/slack_web_api/models/file_object.rb', line 66

def id
  @id
end

#image_exif_rotation ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/slack_web_api/models/file_object.rb', line 70

def image_exif_rotation
  @image_exif_rotation
end

#ims ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


74
75
76
 
# File 'lib/slack_web_api/models/file_object.rb', line 74

def ims
  @ims
end

#is_external ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


78
79
80
 
# File 'lib/slack_web_api/models/file_object.rb', line 78

def is_external
  @is_external
end

#is_public ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


82
83
84
 
# File 'lib/slack_web_api/models/file_object.rb', line 82

def is_public
  @is_public
end

#is_starred ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


86
87
88
 
# File 'lib/slack_web_api/models/file_object.rb', line 86

def is_starred
  @is_starred
end

#is_tombstoned ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


90
91
92
 
# File 'lib/slack_web_api/models/file_object.rb', line 90

def is_tombstoned
  @is_tombstoned
end

#last_editor ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


94
95
96
 
# File 'lib/slack_web_api/models/file_object.rb', line 94

def last_editor
  @last_editor
end

#mimetype ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


98
99
100
 
# File 'lib/slack_web_api/models/file_object.rb', line 98

def mimetype
  @mimetype
end

#mode ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


102
103
104
 
# File 'lib/slack_web_api/models/file_object.rb', line 102

def mode
  @mode
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


106
107
108
 
# File 'lib/slack_web_api/models/file_object.rb', line 106

def name
  @name
end

#non_owner_editable ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


110
111
112
 
# File 'lib/slack_web_api/models/file_object.rb', line 110

def non_owner_editable
  @non_owner_editable
end

#num_stars ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


114
115
116
 
# File 'lib/slack_web_api/models/file_object.rb', line 114

def num_stars
  @num_stars
end

#original_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


118
119
120
 
# File 'lib/slack_web_api/models/file_object.rb', line 118

def original_h
  @original_h
end

#original_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


122
123
124
 
# File 'lib/slack_web_api/models/file_object.rb', line 122

def original_w
  @original_w
end

#permalink ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


126
127
128
 
# File 'lib/slack_web_api/models/file_object.rb', line 126

def permalink
  @permalink
end

#permalink_public ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


130
131
132
 
# File 'lib/slack_web_api/models/file_object.rb', line 130

def permalink_public
  @permalink_public
end

#pinned_info ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


134
135
136
 
# File 'lib/slack_web_api/models/file_object.rb', line 134

def pinned_info
  @pinned_info
end

#pinned_to ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


138
139
140
 
# File 'lib/slack_web_api/models/file_object.rb', line 138

def pinned_to
  @pinned_to
end

#pretty_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


142
143
144
 
# File 'lib/slack_web_api/models/file_object.rb', line 142

def pretty_type
  @pretty_type
end

#preview ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


146
147
148
 
# File 'lib/slack_web_api/models/file_object.rb', line 146

def preview
  @preview
end

#public_url_shared ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


150
151
152
 
# File 'lib/slack_web_api/models/file_object.rb', line 150

def public_url_shared
  @public_url_shared
end

#reactions ⇒ Array[ReactionObject]

TODO: Write general description for this method

Returns:



154
155
156
 
# File 'lib/slack_web_api/models/file_object.rb', line 154

def reactions
  @reactions
end

#shares ⇒ Shares

TODO: Write general description for this method

Returns:



158
159
160
 
# File 'lib/slack_web_api/models/file_object.rb', line 158

def shares
  @shares
end

#size ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


162
163
164
 
# File 'lib/slack_web_api/models/file_object.rb', line 162

def size
  @size
end

#source_team ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


166
167
168
 
# File 'lib/slack_web_api/models/file_object.rb', line 166

def source_team
  @source_team
end

#state ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


170
171
172
 
# File 'lib/slack_web_api/models/file_object.rb', line 170

def state
  @state
end

#thumb_1024 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


174
175
176
 
# File 'lib/slack_web_api/models/file_object.rb', line 174

def thumb_1024
  @thumb_1024
end

#thumb_1024_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


178
179
180
 
# File 'lib/slack_web_api/models/file_object.rb', line 178

def thumb_1024_h
  @thumb_1024_h
end

#thumb_1024_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


182
183
184
 
# File 'lib/slack_web_api/models/file_object.rb', line 182

def thumb_1024_w
  @thumb_1024_w
end

#thumb_160 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


186
187
188
 
# File 'lib/slack_web_api/models/file_object.rb', line 186

def thumb_160
  @thumb_160
end

#thumb_360 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


190
191
192
 
# File 'lib/slack_web_api/models/file_object.rb', line 190

def thumb_360
  @thumb_360
end

#thumb_360_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


194
195
196
 
# File 'lib/slack_web_api/models/file_object.rb', line 194

def thumb_360_h
  @thumb_360_h
end

#thumb_360_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


198
199
200
 
# File 'lib/slack_web_api/models/file_object.rb', line 198

def thumb_360_w
  @thumb_360_w
end

#thumb_480 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


202
203
204
 
# File 'lib/slack_web_api/models/file_object.rb', line 202

def thumb_480
  @thumb_480
end

#thumb_480_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


206
207
208
 
# File 'lib/slack_web_api/models/file_object.rb', line 206

def thumb_480_h
  @thumb_480_h
end

#thumb_480_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


210
211
212
 
# File 'lib/slack_web_api/models/file_object.rb', line 210

def thumb_480_w
  @thumb_480_w
end

#thumb_64 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


214
215
216
 
# File 'lib/slack_web_api/models/file_object.rb', line 214

def thumb_64
  @thumb_64
end

#thumb_720 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


218
219
220
 
# File 'lib/slack_web_api/models/file_object.rb', line 218

def thumb_720
  @thumb_720
end

#thumb_720_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


222
223
224
 
# File 'lib/slack_web_api/models/file_object.rb', line 222

def thumb_720_h
  @thumb_720_h
end

#thumb_720_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


226
227
228
 
# File 'lib/slack_web_api/models/file_object.rb', line 226

def thumb_720_w
  @thumb_720_w
end

#thumb_80 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


230
231
232
 
# File 'lib/slack_web_api/models/file_object.rb', line 230

def thumb_80
  @thumb_80
end

#thumb_800 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


234
235
236
 
# File 'lib/slack_web_api/models/file_object.rb', line 234

def thumb_800
  @thumb_800
end

#thumb_800_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


238
239
240
 
# File 'lib/slack_web_api/models/file_object.rb', line 238

def thumb_800_h
  @thumb_800_h
end

#thumb_800_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


242
243
244
 
# File 'lib/slack_web_api/models/file_object.rb', line 242

def thumb_800_w
  @thumb_800_w
end

#thumb_960 ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


246
247
248
 
# File 'lib/slack_web_api/models/file_object.rb', line 246

def thumb_960
  @thumb_960
end

#thumb_960_h ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


250
251
252
 
# File 'lib/slack_web_api/models/file_object.rb', line 250

def thumb_960_h
  @thumb_960_h
end

#thumb_960_w ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


254
255
256
 
# File 'lib/slack_web_api/models/file_object.rb', line 254

def thumb_960_w
  @thumb_960_w
end

#thumb_tiny ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


258
259
260
 
# File 'lib/slack_web_api/models/file_object.rb', line 258

def thumb_tiny
  @thumb_tiny
end

#timestamp ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


262
263
264
 
# File 'lib/slack_web_api/models/file_object.rb', line 262

def timestamp
  @timestamp
end

#title ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


266
267
268
 
# File 'lib/slack_web_api/models/file_object.rb', line 266

def title
  @title
end

#updated ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


270
271
272
 
# File 'lib/slack_web_api/models/file_object.rb', line 270

def updated
  @updated
end

#url_private ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


274
275
276
 
# File 'lib/slack_web_api/models/file_object.rb', line 274

def url_private
  @url_private
end

#url_private_download ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


278
279
280
 
# File 'lib/slack_web_api/models/file_object.rb', line 278

def url_private_download
  @url_private_download
end

#user ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


282
283
284
 
# File 'lib/slack_web_api/models/file_object.rb', line 282

def user
  @user
end

#user_team ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


286
287
288
 
# File 'lib/slack_web_api/models/file_object.rb', line 286

def user_team
  @user_team
end

#username ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


290
291
292
 
# File 'lib/slack_web_api/models/file_object.rb', line 290

def username
  @username
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/slack_web_api/models/file_object.rb', line 550

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channels = hash.key?('channels') ? hash['channels'] : SKIP
  comments_count =
    hash.key?('comments_count') ? hash['comments_count'] : SKIP
  created = hash.key?('created') ? hash['created'] : SKIP
  date_delete = hash.key?('date_delete') ? hash['date_delete'] : SKIP
  display_as_bot =
    hash.key?('display_as_bot') ? hash['display_as_bot'] : SKIP
  editable = hash.key?('editable') ? hash['editable'] : SKIP
  editor = hash.key?('editor') ? hash['editor'] : SKIP
  external_id = hash.key?('external_id') ? hash['external_id'] : SKIP
  external_type = hash.key?('external_type') ? hash['external_type'] : SKIP
  external_url = hash.key?('external_url') ? hash['external_url'] : SKIP
  filetype = hash.key?('filetype') ? hash['filetype'] : SKIP
  groups = hash.key?('groups') ? hash['groups'] : SKIP
  has_rich_preview =
    hash.key?('has_rich_preview') ? hash['has_rich_preview'] : SKIP
  id = hash.key?('id') ? hash['id'] : SKIP
  image_exif_rotation =
    hash.key?('image_exif_rotation') ? hash['image_exif_rotation'] : SKIP
  ims = hash.key?('ims') ? hash['ims'] : SKIP
  is_external = hash.key?('is_external') ? hash['is_external'] : SKIP
  is_public = hash.key?('is_public') ? hash['is_public'] : SKIP
  is_starred = hash.key?('is_starred') ? hash['is_starred'] : SKIP
  is_tombstoned = hash.key?('is_tombstoned') ? hash['is_tombstoned'] : SKIP
  last_editor = hash.key?('last_editor') ? hash['last_editor'] : SKIP
  mimetype = hash.key?('mimetype') ? hash['mimetype'] : SKIP
  mode = hash.key?('mode') ? hash['mode'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP
  non_owner_editable =
    hash.key?('non_owner_editable') ? hash['non_owner_editable'] : SKIP
  num_stars = hash.key?('num_stars') ? hash['num_stars'] : SKIP
  original_h = hash.key?('original_h') ? hash['original_h'] : SKIP
  original_w = hash.key?('original_w') ? hash['original_w'] : SKIP
  permalink = hash.key?('permalink') ? hash['permalink'] : SKIP
  permalink_public =
    hash.key?('permalink_public') ? hash['permalink_public'] : SKIP
  pinned_info = hash.key?('pinned_info') ? hash['pinned_info'] : SKIP
  pinned_to = hash.key?('pinned_to') ? hash['pinned_to'] : SKIP
  pretty_type = hash.key?('pretty_type') ? hash['pretty_type'] : SKIP
  preview = hash.key?('preview') ? hash['preview'] : SKIP
  public_url_shared =
    hash.key?('public_url_shared') ? hash['public_url_shared'] : SKIP
  # Parameter is an array, so we need to iterate through it

  reactions = nil
  unless hash['reactions'].nil?
    reactions = []
    hash['reactions'].each do |structure|
      reactions << (ReactionObject.from_hash(structure) if structure)
    end
  end

  reactions = SKIP unless hash.key?('reactions')
  shares = Shares.from_hash(hash['shares']) if hash['shares']
  size = hash.key?('size') ? hash['size'] : SKIP
  source_team = hash.key?('source_team') ? hash['source_team'] : SKIP
  state = hash.key?('state') ? hash['state'] : SKIP
  thumb_1024 = hash.key?('thumb_1024') ? hash['thumb_1024'] : SKIP
  thumb_1024_h = hash.key?('thumb_1024_h') ? hash['thumb_1024_h'] : SKIP
  thumb_1024_w = hash.key?('thumb_1024_w') ? hash['thumb_1024_w'] : SKIP
  thumb_160 = hash.key?('thumb_160') ? hash['thumb_160'] : SKIP
  thumb_360 = hash.key?('thumb_360') ? hash['thumb_360'] : SKIP
  thumb_360_h = hash.key?('thumb_360_h') ? hash['thumb_360_h'] : SKIP
  thumb_360_w = hash.key?('thumb_360_w') ? hash['thumb_360_w'] : SKIP
  thumb_480 = hash.key?('thumb_480') ? hash['thumb_480'] : SKIP
  thumb_480_h = hash.key?('thumb_480_h') ? hash['thumb_480_h'] : SKIP
  thumb_480_w = hash.key?('thumb_480_w') ? hash['thumb_480_w'] : SKIP
  thumb_64 = hash.key?('thumb_64') ? hash['thumb_64'] : SKIP
  thumb_720 = hash.key?('thumb_720') ? hash['thumb_720'] : SKIP
  thumb_720_h = hash.key?('thumb_720_h') ? hash['thumb_720_h'] : SKIP
  thumb_720_w = hash.key?('thumb_720_w') ? hash['thumb_720_w'] : SKIP
  thumb_80 = hash.key?('thumb_80') ? hash['thumb_80'] : SKIP
  thumb_800 = hash.key?('thumb_800') ? hash['thumb_800'] : SKIP
  thumb_800_h = hash.key?('thumb_800_h') ? hash['thumb_800_h'] : SKIP
  thumb_800_w = hash.key?('thumb_800_w') ? hash['thumb_800_w'] : SKIP
  thumb_960 = hash.key?('thumb_960') ? hash['thumb_960'] : SKIP
  thumb_960_h = hash.key?('thumb_960_h') ? hash['thumb_960_h'] : SKIP
  thumb_960_w = hash.key?('thumb_960_w') ? hash['thumb_960_w'] : SKIP
  thumb_tiny = hash.key?('thumb_tiny') ? hash['thumb_tiny'] : SKIP
  timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
  title = hash.key?('title') ? hash['title'] : SKIP
  updated = hash.key?('updated') ? hash['updated'] : SKIP
  url_private = hash.key?('url_private') ? hash['url_private'] : SKIP
  url_private_download =
    hash.key?('url_private_download') ? hash['url_private_download'] : SKIP
  user = hash.key?('user') ? hash['user'] : SKIP
  user_team = hash.key?('user_team') ? hash['user_team'] : SKIP
  username = hash.key?('username') ? hash['username'] : 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.

  FileObject.new(channels: channels,
                 comments_count: comments_count,
                 created: created,
                 date_delete: date_delete,
                 display_as_bot: display_as_bot,
                 editable: editable,
                 editor: editor,
                 external_id: external_id,
                 external_type: external_type,
                 external_url: external_url,
                 filetype: filetype,
                 groups: groups,
                 has_rich_preview: has_rich_preview,
                 id: id,
                 image_exif_rotation: image_exif_rotation,
                 ims: ims,
                 is_external: is_external,
                 is_public: is_public,
                 is_starred: is_starred,
                 is_tombstoned: is_tombstoned,
                 last_editor: last_editor,
                 mimetype: mimetype,
                 mode: mode,
                 name: name,
                 non_owner_editable: non_owner_editable,
                 num_stars: num_stars,
                 original_h: original_h,
                 original_w: original_w,
                 permalink: permalink,
                 permalink_public: permalink_public,
                 pinned_info: pinned_info,
                 pinned_to: pinned_to,
                 pretty_type: pretty_type,
                 preview: preview,
                 public_url_shared: public_url_shared,
                 reactions: reactions,
                 shares: shares,
                 size: size,
                 source_team: source_team,
                 state: state,
                 thumb_1024: thumb_1024,
                 thumb_1024_h: thumb_1024_h,
                 thumb_1024_w: thumb_1024_w,
                 thumb_160: thumb_160,
                 thumb_360: thumb_360,
                 thumb_360_h: thumb_360_h,
                 thumb_360_w: thumb_360_w,
                 thumb_480: thumb_480,
                 thumb_480_h: thumb_480_h,
                 thumb_480_w: thumb_480_w,
                 thumb_64: thumb_64,
                 thumb_720: thumb_720,
                 thumb_720_h: thumb_720_h,
                 thumb_720_w: thumb_720_w,
                 thumb_80: thumb_80,
                 thumb_800: thumb_800,
                 thumb_800_h: thumb_800_h,
                 thumb_800_w: thumb_800_w,
                 thumb_960: thumb_960,
                 thumb_960_h: thumb_960_h,
                 thumb_960_w: thumb_960_w,
                 thumb_tiny: thumb_tiny,
                 timestamp: timestamp,
                 title: title,
                 updated: updated,
                 url_private: url_private,
                 url_private_download: url_private_download,
                 user: user,
                 user_team: user_team,
                 username: username,
                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/slack_web_api/models/file_object.rb', line 293

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channels'] = 'channels'
  @_hash['comments_count'] = 'comments_count'
  @_hash['created'] = 'created'
  @_hash['date_delete'] = 'date_delete'
  @_hash['display_as_bot'] = 'display_as_bot'
  @_hash['editable'] = 'editable'
  @_hash['editor'] = 'editor'
  @_hash['external_id'] = 'external_id'
  @_hash['external_type'] = 'external_type'
  @_hash['external_url'] = 'external_url'
  @_hash['filetype'] = 'filetype'
  @_hash['groups'] = 'groups'
  @_hash['has_rich_preview'] = 'has_rich_preview'
  @_hash['id'] = 'id'
  @_hash['image_exif_rotation'] = 'image_exif_rotation'
  @_hash['ims'] = 'ims'
  @_hash['is_external'] = 'is_external'
  @_hash['is_public'] = 'is_public'
  @_hash['is_starred'] = 'is_starred'
  @_hash['is_tombstoned'] = 'is_tombstoned'
  @_hash['last_editor'] = 'last_editor'
  @_hash['mimetype'] = 'mimetype'
  @_hash['mode'] = 'mode'
  @_hash['name'] = 'name'
  @_hash['non_owner_editable'] = 'non_owner_editable'
  @_hash['num_stars'] = 'num_stars'
  @_hash['original_h'] = 'original_h'
  @_hash['original_w'] = 'original_w'
  @_hash['permalink'] = 'permalink'
  @_hash['permalink_public'] = 'permalink_public'
  @_hash['pinned_info'] = 'pinned_info'
  @_hash['pinned_to'] = 'pinned_to'
  @_hash['pretty_type'] = 'pretty_type'
  @_hash['preview'] = 'preview'
  @_hash['public_url_shared'] = 'public_url_shared'
  @_hash['reactions'] = 'reactions'
  @_hash['shares'] = 'shares'
  @_hash['size'] = 'size'
  @_hash['source_team'] = 'source_team'
  @_hash['state'] = 'state'
  @_hash['thumb_1024'] = 'thumb_1024'
  @_hash['thumb_1024_h'] = 'thumb_1024_h'
  @_hash['thumb_1024_w'] = 'thumb_1024_w'
  @_hash['thumb_160'] = 'thumb_160'
  @_hash['thumb_360'] = 'thumb_360'
  @_hash['thumb_360_h'] = 'thumb_360_h'
  @_hash['thumb_360_w'] = 'thumb_360_w'
  @_hash['thumb_480'] = 'thumb_480'
  @_hash['thumb_480_h'] = 'thumb_480_h'
  @_hash['thumb_480_w'] = 'thumb_480_w'
  @_hash['thumb_64'] = 'thumb_64'
  @_hash['thumb_720'] = 'thumb_720'
  @_hash['thumb_720_h'] = 'thumb_720_h'
  @_hash['thumb_720_w'] = 'thumb_720_w'
  @_hash['thumb_80'] = 'thumb_80'
  @_hash['thumb_800'] = 'thumb_800'
  @_hash['thumb_800_h'] = 'thumb_800_h'
  @_hash['thumb_800_w'] = 'thumb_800_w'
  @_hash['thumb_960'] = 'thumb_960'
  @_hash['thumb_960_h'] = 'thumb_960_h'
  @_hash['thumb_960_w'] = 'thumb_960_w'
  @_hash['thumb_tiny'] = 'thumb_tiny'
  @_hash['timestamp'] = 'timestamp'
  @_hash['title'] = 'title'
  @_hash['updated'] = 'updated'
  @_hash['url_private'] = 'url_private'
  @_hash['url_private_download'] = 'url_private_download'
  @_hash['user'] = 'user'
  @_hash['user_team'] = 'user_team'
  @_hash['username'] = 'username'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



445
446
447
 
# File 'lib/slack_web_api/models/file_object.rb', line 445

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/slack_web_api/models/file_object.rb', line 369

def self.optionals
  %w[
    channels
    comments_count
    created
    date_delete
    display_as_bot
    editable
    editor
    external_id
    external_type
    external_url
    filetype
    groups
    has_rich_preview
    id
    image_exif_rotation
    ims
    is_external
    is_public
    is_starred
    is_tombstoned
    last_editor
    mimetype
    mode
    name
    non_owner_editable
    num_stars
    original_h
    original_w
    permalink
    permalink_public
    pinned_info
    pinned_to
    pretty_type
    preview
    public_url_shared
    reactions
    shares
    size
    source_team
    state
    thumb_1024
    thumb_1024_h
    thumb_1024_w
    thumb_160
    thumb_360
    thumb_360_h
    thumb_360_w
    thumb_480
    thumb_480_h
    thumb_480_w
    thumb_64
    thumb_720
    thumb_720_h
    thumb_720_w
    thumb_80
    thumb_800
    thumb_800_h
    thumb_800_w
    thumb_960
    thumb_960_h
    thumb_960_w
    thumb_tiny
    timestamp
    title
    updated
    url_private
    url_private_download
    user
    user_team
    username
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/slack_web_api/models/file_object.rb', line 753

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} channels: #{@channels.inspect}, comments_count: #{@comments_count.inspect},"\
  " created: #{@created.inspect}, date_delete: #{@date_delete.inspect}, display_as_bot:"\
  " #{@display_as_bot.inspect}, editable: #{@editable.inspect}, editor: #{@editor.inspect},"\
  " external_id: #{@external_id.inspect}, external_type: #{@external_type.inspect},"\
  " external_url: #{@external_url.inspect}, filetype: #{@filetype.inspect}, groups:"\
  " #{@groups.inspect}, has_rich_preview: #{@has_rich_preview.inspect}, id: #{@id.inspect},"\
  " image_exif_rotation: #{@image_exif_rotation.inspect}, ims: #{@ims.inspect}, is_external:"\
  " #{@is_external.inspect}, is_public: #{@is_public.inspect}, is_starred:"\
  " #{@is_starred.inspect}, is_tombstoned: #{@is_tombstoned.inspect}, last_editor:"\
  " #{@last_editor.inspect}, mimetype: #{@mimetype.inspect}, mode: #{@mode.inspect}, name:"\
  " #{@name.inspect}, non_owner_editable: #{@non_owner_editable.inspect}, num_stars:"\
  " #{@num_stars.inspect}, original_h: #{@original_h.inspect}, original_w:"\
  " #{@original_w.inspect}, permalink: #{@permalink.inspect}, permalink_public:"\
  " #{@permalink_public.inspect}, pinned_info: #{@pinned_info.inspect}, pinned_to:"\
  " #{@pinned_to.inspect}, pretty_type: #{@pretty_type.inspect}, preview: #{@preview.inspect},"\
  " public_url_shared: #{@public_url_shared.inspect}, reactions: #{@reactions.inspect},"\
  " shares: #{@shares.inspect}, size: #{@size.inspect}, source_team: #{@source_team.inspect},"\
  " state: #{@state.inspect}, thumb_1024: #{@thumb_1024.inspect}, thumb_1024_h:"\
  " #{@thumb_1024_h.inspect}, thumb_1024_w: #{@thumb_1024_w.inspect}, thumb_160:"\
  " #{@thumb_160.inspect}, thumb_360: #{@thumb_360.inspect}, thumb_360_h:"\
  " #{@thumb_360_h.inspect}, thumb_360_w: #{@thumb_360_w.inspect}, thumb_480:"\
  " #{@thumb_480.inspect}, thumb_480_h: #{@thumb_480_h.inspect}, thumb_480_w:"\
  " #{@thumb_480_w.inspect}, thumb_64: #{@thumb_64.inspect}, thumb_720: #{@thumb_720.inspect},"\
  " thumb_720_h: #{@thumb_720_h.inspect}, thumb_720_w: #{@thumb_720_w.inspect}, thumb_80:"\
  " #{@thumb_80.inspect}, thumb_800: #{@thumb_800.inspect}, thumb_800_h:"\
  " #{@thumb_800_h.inspect}, thumb_800_w: #{@thumb_800_w.inspect}, thumb_960:"\
  " #{@thumb_960.inspect}, thumb_960_h: #{@thumb_960_h.inspect}, thumb_960_w:"\
  " #{@thumb_960_w.inspect}, thumb_tiny: #{@thumb_tiny.inspect}, timestamp:"\
  " #{@timestamp.inspect}, title: #{@title.inspect}, updated: #{@updated.inspect},"\
  " url_private: #{@url_private.inspect}, url_private_download:"\
  " #{@url_private_download.inspect}, user: #{@user.inspect}, user_team:"\
  " #{@user_team.inspect}, username: #{@username.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/slack_web_api/models/file_object.rb', line 724

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} channels: #{@channels}, comments_count: #{@comments_count}, created:"\
  " #{@created}, date_delete: #{@date_delete}, display_as_bot: #{@display_as_bot}, editable:"\
  " #{@editable}, editor: #{@editor}, external_id: #{@external_id}, external_type:"\
  " #{@external_type}, external_url: #{@external_url}, filetype: #{@filetype}, groups:"\
  " #{@groups}, has_rich_preview: #{@has_rich_preview}, id: #{@id}, image_exif_rotation:"\
  " #{@image_exif_rotation}, ims: #{@ims}, is_external: #{@is_external}, is_public:"\
  " #{@is_public}, is_starred: #{@is_starred}, is_tombstoned: #{@is_tombstoned}, last_editor:"\
  " #{@last_editor}, mimetype: #{@mimetype}, mode: #{@mode}, name: #{@name},"\
  " non_owner_editable: #{@non_owner_editable}, num_stars: #{@num_stars}, original_h:"\
  " #{@original_h}, original_w: #{@original_w}, permalink: #{@permalink}, permalink_public:"\
  " #{@permalink_public}, pinned_info: #{@pinned_info}, pinned_to: #{@pinned_to}, pretty_type:"\
  " #{@pretty_type}, preview: #{@preview}, public_url_shared: #{@public_url_shared},"\
  " reactions: #{@reactions}, shares: #{@shares}, size: #{@size}, source_team:"\
  " #{@source_team}, state: #{@state}, thumb_1024: #{@thumb_1024}, thumb_1024_h:"\
  " #{@thumb_1024_h}, thumb_1024_w: #{@thumb_1024_w}, thumb_160: #{@thumb_160}, thumb_360:"\
  " #{@thumb_360}, thumb_360_h: #{@thumb_360_h}, thumb_360_w: #{@thumb_360_w}, thumb_480:"\
  " #{@thumb_480}, thumb_480_h: #{@thumb_480_h}, thumb_480_w: #{@thumb_480_w}, thumb_64:"\
  " #{@thumb_64}, thumb_720: #{@thumb_720}, thumb_720_h: #{@thumb_720_h}, thumb_720_w:"\
  " #{@thumb_720_w}, thumb_80: #{@thumb_80}, thumb_800: #{@thumb_800}, thumb_800_h:"\
  " #{@thumb_800_h}, thumb_800_w: #{@thumb_800_w}, thumb_960: #{@thumb_960}, thumb_960_h:"\
  " #{@thumb_960_h}, thumb_960_w: #{@thumb_960_w}, thumb_tiny: #{@thumb_tiny}, timestamp:"\
  " #{@timestamp}, title: #{@title}, updated: #{@updated}, url_private: #{@url_private},"\
  " url_private_download: #{@url_private_download}, user: #{@user}, user_team: #{@user_team},"\
  " username: #{@username}, additional_properties: #{@additional_properties}>"
end