Class: Teamlab::Files
- Inherits:
-
Object
- Object
- Teamlab::Files
- Defined in:
- lib/teamlab/Modules/Files.rb
Instance Method Summary collapse
- #check_conflict(options = {}) ⇒ Object
- #check_conversion_status(fileid) ⇒ Object
- #chunked_upload(folder_id, filename, file_size) ⇒ Object
- #clear_recycle_bin ⇒ Object
- #copy_to_folder(dest_folder_id, options = {}) ⇒ Object
- #create_file(folder_id, title) ⇒ Object
- #create_html(folder_id, title, content) ⇒ Object
- #create_html_in_common_docs(title, content) ⇒ Object
- #create_html_in_my_docs(title, content) ⇒ Object
- #create_txt(folder_id, title, content) ⇒ Object
- #create_txt_in_common_docs(title, content) ⇒ Object
-
#create_txt_in_my_docs(title, content) ⇒ Object
region File Creation.
- #delete(options = {}) ⇒ Object
- #delete_file(file_id) ⇒ Object
- #delete_folder(folder_id) ⇒ Object
- #document_server_info ⇒ Object
- #finish_all ⇒ Object
- #finish_operations(options = {}) ⇒ Object
- #generate_shared_link(file_id, share) ⇒ Object
- #get_common_docs ⇒ Object
- #get_file_history(file_id) ⇒ Object
-
#get_file_info(file_id) ⇒ Object
region Files.
-
#get_file_operations_list ⇒ Object
region File operations.
-
#get_file_sharing(file_id) ⇒ Object
region Sharing.
- #get_folder(folder_id, options = {}) ⇒ Object
- #get_folder_info(folder_id) ⇒ Object
- #get_folder_path(folder_id) ⇒ Object
- #get_folder_sharing(folder_id) ⇒ Object
-
#get_my_docs ⇒ Object
(also: #get_my_files)
region Folders.
- #get_projects_folder ⇒ Object
- #get_shared_docs ⇒ Object
-
#get_third_party ⇒ Object
region Third-Party Integration.
- #get_trash ⇒ Object
-
#initialize ⇒ Files
constructor
A new instance of Files.
- #insert_file(folder_id, file, title) ⇒ Object
- #mark_as_read ⇒ Object
- #move_to_folder(dest_folder_id, options = {}) ⇒ Object (also: #move_files)
- #new_folder(folder_id, title) ⇒ Object
- #remove_third_party_account(provider_id) ⇒ Object
- #removes_sharing_rights(options = {}) ⇒ Object
- #rename_folder(folder_id, title) ⇒ Object
- #save_third_party(options = {}) ⇒ Object
-
#search(query) ⇒ Object
endregion.
- #share_file(file_id, user_id, access_type, options = {}) ⇒ Object
- #share_folder(folder_id, user_id, access_type, options = {}) ⇒ Object
- #start_conversion(file_id, start) ⇒ Object
- #update_file_history(file_id, version, continue_version = false) ⇒ Object
- #update_file_info(file_id, title, last_version) ⇒ Object
- #upload_to_common_docs(file) ⇒ Object
- #upload_to_folder(folder_id, file) ⇒ Object
-
#upload_to_my_docs(file) ⇒ Object
region Uploads.
Constructor Details
#initialize ⇒ Files
Returns a new instance of Files.
4 5 6 |
# File 'lib/teamlab/Modules/Files.rb', line 4 def initialize @request = Teamlab::Request.new('files') end |
Instance Method Details
#check_conflict(options = {}) ⇒ Object
46 47 48 |
# File 'lib/teamlab/Modules/Files.rb', line 46 def check_conflict( = {}) @request.get(%w(fileops move), ) end |
#check_conversion_status(fileid) ⇒ Object
50 51 52 |
# File 'lib/teamlab/Modules/Files.rb', line 50 def check_conversion_status(fileid) @request.get(['fileops', fileid.to_s, 'checkconversion']) end |
#chunked_upload(folder_id, filename, file_size) ⇒ Object
220 221 222 |
# File 'lib/teamlab/Modules/Files.rb', line 220 def chunked_upload(folder_id, filename, file_size) @request.post([folder_id.to_s, 'upload', 'create_session'], fileName: filename, fileSize: file_size) end |
#clear_recycle_bin ⇒ Object
75 76 77 |
# File 'lib/teamlab/Modules/Files.rb', line 75 def clear_recycle_bin @request.put(%w(fileops emptytrash)) end |
#copy_to_folder(dest_folder_id, options = {}) ⇒ Object
59 60 61 |
# File 'lib/teamlab/Modules/Files.rb', line 59 def copy_to_folder(dest_folder_id, = {}) @request.put(%w(fileops copy), { destFolderId: dest_folder_id }.merge()) end |
#create_file(folder_id, title) ⇒ Object
34 35 36 |
# File 'lib/teamlab/Modules/Files.rb', line 34 def create_file(folder_id, title) @request.post([folder_id.to_s, 'file'], title: title.to_s) end |
#create_html(folder_id, title, content) ⇒ Object
30 31 32 |
# File 'lib/teamlab/Modules/Files.rb', line 30 def create_html(folder_id, title, content) @request.post([folder_id.to_s, 'html'], title: title.to_s, content: content.to_s) end |
#create_html_in_common_docs(title, content) ⇒ Object
22 23 24 |
# File 'lib/teamlab/Modules/Files.rb', line 22 def create_html_in_common_docs(title, content) @request.post(%w(common html), title: title.to_s, content: content.to_s) end |
#create_html_in_my_docs(title, content) ⇒ Object
14 15 16 |
# File 'lib/teamlab/Modules/Files.rb', line 14 def create_html_in_my_docs(title, content) @request.post(%w(@my html), title: title.to_s, content: content.to_s) end |
#create_txt(folder_id, title, content) ⇒ Object
26 27 28 |
# File 'lib/teamlab/Modules/Files.rb', line 26 def create_txt(folder_id, title, content) @request.post([folder_id.to_s, 'text'], title: title.to_s, content: content.to_s) end |
#create_txt_in_common_docs(title, content) ⇒ Object
18 19 20 |
# File 'lib/teamlab/Modules/Files.rb', line 18 def create_txt_in_common_docs(title, content) @request.post(%w(@common text), title: title.to_s, content: content.to_s) end |
#create_txt_in_my_docs(title, content) ⇒ Object
region File Creation
10 11 12 |
# File 'lib/teamlab/Modules/Files.rb', line 10 def create_txt_in_my_docs(title, content) @request.post(%w(@my text), title: title.to_s, content: content.to_s) end |
#delete(options = {}) ⇒ Object
63 64 65 |
# File 'lib/teamlab/Modules/Files.rb', line 63 def delete( = {}) @request.put(%w(fileops delete), ) end |
#delete_file(file_id) ⇒ Object
107 108 109 |
# File 'lib/teamlab/Modules/Files.rb', line 107 def delete_file(file_id) @request.delete(['file', file_id.to_s]) end |
#delete_folder(folder_id) ⇒ Object
156 157 158 |
# File 'lib/teamlab/Modules/Files.rb', line 156 def delete_folder(folder_id) @request.delete(['folder', folder_id.to_s]) end |
#document_server_info ⇒ Object
234 235 236 |
# File 'lib/teamlab/Modules/Files.rb', line 234 def document_server_info @request.get(%w(docservice)) end |
#finish_all ⇒ Object
67 68 69 |
# File 'lib/teamlab/Modules/Files.rb', line 67 def finish_all @request.put(%w(fileops terminate)) end |
#finish_operations(options = {}) ⇒ Object
79 80 81 |
# File 'lib/teamlab/Modules/Files.rb', line 79 def finish_operations( = {}) @request.put(%w(fileops bulkdownload), ) end |
#generate_shared_link(file_id, share) ⇒ Object
230 231 232 |
# File 'lib/teamlab/Modules/Files.rb', line 230 def generate_shared_link(file_id, share) @request.put([file_id.to_s, 'sharedlink'], share: share) end |
#get_common_docs ⇒ Object
128 129 130 |
# File 'lib/teamlab/Modules/Files.rb', line 128 def get_common_docs @request.get(['@common']) end |
#get_file_history(file_id) ⇒ Object
95 96 97 |
# File 'lib/teamlab/Modules/Files.rb', line 95 def get_file_history(file_id) @request.get(['file', file_id.to_s, 'history']) end |
#get_file_info(file_id) ⇒ Object
region Files
91 92 93 |
# File 'lib/teamlab/Modules/Files.rb', line 91 def get_file_info(file_id) @request.get(['file', file_id.to_s]) end |
#get_file_operations_list ⇒ Object
region File operations
42 43 44 |
# File 'lib/teamlab/Modules/Files.rb', line 42 def get_file_operations_list @request.get(%w(fileops)) end |
#get_file_sharing(file_id) ⇒ Object
region Sharing
164 165 166 |
# File 'lib/teamlab/Modules/Files.rb', line 164 def get_file_sharing(file_id) @request.get(['file', file_id.to_s, 'share']) end |
#get_folder(folder_id, options = {}) ⇒ Object
136 137 138 |
# File 'lib/teamlab/Modules/Files.rb', line 136 def get_folder(folder_id, = {}) @request.get([folder_id.to_s], ) end |
#get_folder_info(folder_id) ⇒ Object
140 141 142 |
# File 'lib/teamlab/Modules/Files.rb', line 140 def get_folder_info(folder_id) @request.get(['folder', folder_id.to_s]) end |
#get_folder_path(folder_id) ⇒ Object
144 145 146 |
# File 'lib/teamlab/Modules/Files.rb', line 144 def get_folder_path(folder_id) @request.get(['folder', folder_id.to_s, 'path']) end |
#get_folder_sharing(folder_id) ⇒ Object
168 169 170 |
# File 'lib/teamlab/Modules/Files.rb', line 168 def get_folder_sharing(folder_id) @request.get(['folder', folder_id.to_s, 'share']) end |
#get_my_docs ⇒ Object Also known as: get_my_files
region Folders
115 116 117 |
# File 'lib/teamlab/Modules/Files.rb', line 115 def get_my_docs @request.get(['@my']) end |
#get_projects_folder ⇒ Object
132 133 134 |
# File 'lib/teamlab/Modules/Files.rb', line 132 def get_projects_folder @request.get(['@projects']) end |
#get_shared_docs ⇒ Object
120 121 122 |
# File 'lib/teamlab/Modules/Files.rb', line 120 def get_shared_docs @request.get(['@share']) end |
#get_third_party ⇒ Object
region Third-Party Integration
188 189 190 |
# File 'lib/teamlab/Modules/Files.rb', line 188 def get_third_party @request.get(%w(thirdparty)) end |
#get_trash ⇒ Object
124 125 126 |
# File 'lib/teamlab/Modules/Files.rb', line 124 def get_trash @request.get(['@trash']) end |
#insert_file(folder_id, file, title) ⇒ Object
216 217 218 |
# File 'lib/teamlab/Modules/Files.rb', line 216 def insert_file(folder_id, file, title) @request.post([folder_id.to_s, 'insert'], somefile: File.new(file), title: title) end |
#mark_as_read ⇒ Object
71 72 73 |
# File 'lib/teamlab/Modules/Files.rb', line 71 def mark_as_read @request.put(%w(fileops markasread)) end |
#move_to_folder(dest_folder_id, options = {}) ⇒ Object Also known as: move_files
54 55 56 |
# File 'lib/teamlab/Modules/Files.rb', line 54 def move_to_folder(dest_folder_id, = {}) @request.put(%w(fileops move), { destFolderId: dest_folder_id }.merge()) end |
#new_folder(folder_id, title) ⇒ Object
148 149 150 |
# File 'lib/teamlab/Modules/Files.rb', line 148 def new_folder(folder_id, title) @request.post(['folder', folder_id.to_s], title: title) end |
#remove_third_party_account(provider_id) ⇒ Object
196 197 198 |
# File 'lib/teamlab/Modules/Files.rb', line 196 def remove_third_party_account(provider_id) @request.delete(['thirdparty', provider_id.to_s]) end |
#removes_sharing_rights(options = {}) ⇒ Object
180 181 182 |
# File 'lib/teamlab/Modules/Files.rb', line 180 def removes_sharing_rights( = {}) @request.delete(['share'], ) end |
#rename_folder(folder_id, title) ⇒ Object
152 153 154 |
# File 'lib/teamlab/Modules/Files.rb', line 152 def rename_folder(folder_id, title) @request.put(['folder', folder_id.to_s], title: title) end |
#save_third_party(options = {}) ⇒ Object
192 193 194 |
# File 'lib/teamlab/Modules/Files.rb', line 192 def save_third_party( = {}) @request.post(%w(thirdparty), ) end |
#search(query) ⇒ Object
endregion
226 227 228 |
# File 'lib/teamlab/Modules/Files.rb', line 226 def search(query) @request.get(['@search', query.to_s]) end |
#share_file(file_id, user_id, access_type, options = {}) ⇒ Object
172 173 174 |
# File 'lib/teamlab/Modules/Files.rb', line 172 def share_file(file_id, user_id, access_type, = {}) @request.put(['file', file_id.to_s, 'share'], { share: { shareTo: user_id, Access: access_type } }.merge()) end |
#share_folder(folder_id, user_id, access_type, options = {}) ⇒ Object
176 177 178 |
# File 'lib/teamlab/Modules/Files.rb', line 176 def share_folder(folder_id, user_id, access_type, = {}) @request.put(['folder', folder_id.to_s, 'share'], { share: { shareTo: user_id, Access: access_type } }.merge()) end |
#start_conversion(file_id, start) ⇒ Object
83 84 85 |
# File 'lib/teamlab/Modules/Files.rb', line 83 def start_conversion(file_id, start) @request.put(['file', file_id.to_s, 'checkconversion'], start: start) end |
#update_file_history(file_id, version, continue_version = false) ⇒ Object
99 100 101 |
# File 'lib/teamlab/Modules/Files.rb', line 99 def update_file_history(file_id, version, continue_version = false) @request.put(['file', file_id.to_s, 'history'], version: version, continueVersion: continue_version) end |
#update_file_info(file_id, title, last_version) ⇒ Object
103 104 105 |
# File 'lib/teamlab/Modules/Files.rb', line 103 def update_file_info(file_id, title, last_version) @request.put(['file', file_id.to_s], title: title, lastVersion: last_version) end |
#upload_to_common_docs(file) ⇒ Object
208 209 210 |
# File 'lib/teamlab/Modules/Files.rb', line 208 def upload_to_common_docs(file) @request.post(%w(@common upload), somefile: File.new(file)) end |
#upload_to_folder(folder_id, file) ⇒ Object
212 213 214 |
# File 'lib/teamlab/Modules/Files.rb', line 212 def upload_to_folder(folder_id, file) @request.post([folder_id.to_s, 'upload'], somefile: File.new(file)) end |
#upload_to_my_docs(file) ⇒ Object
region Uploads
204 205 206 |
# File 'lib/teamlab/Modules/Files.rb', line 204 def upload_to_my_docs(file) @request.post(%w(@my upload), somefile: File.new(file)) end |