Class: Dogapi::V1::ScreenboardService

Inherits:
APIService
  • Object
show all
Defined in:
lib/dogapi/v1/screenboard.rb

Constant Summary collapse

API_VERSION =
'v1'

Instance Attribute Summary

Attributes inherited from APIService

#api_key, #application_key

Instance Method Summary collapse

Methods inherited from APIService

#connect, #handle_redirect, #handle_response, #initialize, #prepare_params, #prepare_request, #request, #should_set_api_and_app_keys_in_params?, #suppress_error_if_silent

Constructor Details

This class inherits a constructor from Dogapi::APIService

Instance Method Details

#create_screenboard(description) ⇒ Object



12
13
14
# File 'lib/dogapi/v1/screenboard.rb', line 12

def create_screenboard(description)
  request(Net::HTTP::Post, "/api/#{API_VERSION}/screen", nil, description, true)
end

#delete_screenboard(board_id) ⇒ Object



28
29
30
# File 'lib/dogapi/v1/screenboard.rb', line 28

def delete_screenboard(board_id)
  request(Net::HTTP::Delete, "/api/#{API_VERSION}/screen/#{board_id}", nil, nil, false)
end

#get_all_screenboardsObject



24
25
26
# File 'lib/dogapi/v1/screenboard.rb', line 24

def get_all_screenboards()
  request(Net::HTTP::Get, "/api/#{API_VERSION}/screen", nil, nil, false)
end

#get_screenboard(board_id) ⇒ Object



20
21
22
# File 'lib/dogapi/v1/screenboard.rb', line 20

def get_screenboard(board_id)
  request(Net::HTTP::Get, "/api/#{API_VERSION}/screen/#{board_id}", nil, nil, false)
end

#revoke_screenboard(board_id) ⇒ Object



36
37
38
# File 'lib/dogapi/v1/screenboard.rb', line 36

def revoke_screenboard(board_id)
  request(Net::HTTP::Delete, "/api/#{API_VERSION}/screen/share/#{board_id}", nil, nil, false)
end

#share_screenboard(board_id) ⇒ Object



32
33
34
# File 'lib/dogapi/v1/screenboard.rb', line 32

def share_screenboard(board_id)
  request(Net::HTTP::Post, "/api/#{API_VERSION}/screen/share/#{board_id}", nil, nil, false)
end

#update_screenboard(board_id, description) ⇒ Object



16
17
18
# File 'lib/dogapi/v1/screenboard.rb', line 16

def update_screenboard(board_id, description)
  request(Net::HTTP::Put, "/api/#{API_VERSION}/screen/#{board_id}", nil, description, true)
end