Class: LabClient::BroadcastMessages

Inherits:
Common
  • Object
show all
Defined in:
lib/labclient/broadcast_messages/list.rb,
lib/labclient/broadcast_messages/show.rb,
lib/labclient/broadcast_messages/create.rb,
lib/labclient/broadcast_messages/delete.rb,
lib/labclient/broadcast_messages/update.rb

Overview

Specifics

Constant Summary

Constants included from AccessLevel

AccessLevel::HUMAN_ACCESS_LEVELS, AccessLevel::MACHINE_ACCESS_LEVELS

Instance Attribute Summary

Attributes inherited from Common

#client

Instance Method Summary collapse

Methods inherited from Common

#api_methods, #api_methods_help, #format_id, #format_query_id, #format_query_ids, #format_time?, #group_name, #help, #initialize, #inspect, #klass, #protected_query_access_level, #query_access_level, #query_format_time

Methods included from Docs

#demo, #desc, #doc, docs, #example, #group_name, #help, json, #markdown, #navigation, #option, #result, #subtitle, #title

Methods included from AccessLevel

#human_access_level, #human_protected_access_level, #machine_access_level, #machine_protected_access_level

Constructor Details

This class inherits a constructor from LabClient::Common

Instance Method Details

#create(query = {}) ⇒ Object

Create



59
60
61
62
63
64
 
# File 'lib/labclient/broadcast_messages/create.rb', line 59

def create(query = {})
  query[:starts_at] = query[:starts_at].to_time.iso8601 if format_time?(query[:starts_at])
  query[:ends_at] = query[:ends_at].to_time.iso8601 if format_time?(query[:ends_at])

  client.request(:post, 'broadcast_messages', BroadcastMessage, query)
end

#delete(broadcast_message_id = nil) ⇒ Object

Delete



32
33
34
 
# File 'lib/labclient/broadcast_messages/delete.rb', line 32

def delete(broadcast_message_id = nil)
  client.request(:delete, "broadcast_messages/#{broadcast_message_id}")
end

#list ⇒ Object

List



14
15
16
 
# File 'lib/labclient/broadcast_messages/list.rb', line 14

def list
  client.request(:get, 'broadcast_messages', BroadcastMessage)
end

#show(broadcast_message_id = nil) ⇒ Object

Show Specific



14
15
16
 
# File 'lib/labclient/broadcast_messages/show.rb', line 14

def show(broadcast_message_id = nil)
  client.request(:get, "broadcast_messages/#{broadcast_message_id}", BroadcastMessage)
end

#update(broadcast_message_id = nil, query = {}) ⇒ Object

Update



68
69
70
71
72
73
 
# File 'lib/labclient/broadcast_messages/update.rb', line 68

def update(broadcast_message_id = nil, query = {})
  query[:starts_at] = query[:starts_at].to_time.iso8601 if format_time?(query[:starts_at])
  query[:ends_at] = query[:ends_at].to_time.iso8601 if format_time?(query[:ends_at])

  client.request(:put, "broadcast_messages/#{broadcast_message_id}", BroadcastMessage, query)
end