class Teamlab::Files

Public Class Methods

new(config = nil) click to toggle source
# File lib/teamlab/modules/files.rb, line 5
def initialize(config = nil)
  @request = Teamlab::Request.new(config, 'files')
end

Public Instance Methods

check_conflict(options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 47
def check_conflict(options = {})
  @request.get(%w[fileops move], options)
end
check_conversion_status(fileid) click to toggle source
# File lib/teamlab/modules/files.rb, line 51
def check_conversion_status(fileid)
  @request.get(['file', fileid.to_s, 'checkconversion'])
end
check_overwrite(set_value = true) click to toggle source
# File lib/teamlab/modules/files.rb, line 252
def check_overwrite(set_value = true)
  @request.put(%w[updateifexist], set: set_value)
end
chunked_upload(folder_id, filename, file_size) click to toggle source
# File lib/teamlab/modules/files.rb, line 234
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() click to toggle source
# File lib/teamlab/modules/files.rb, line 76
def clear_recycle_bin
  @request.put(%w[fileops emptytrash])
end
copy_to_folder(dest_folder_id, options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 60
def copy_to_folder(dest_folder_id, options = {})
  @request.put(%w[fileops copy], { destFolderId: dest_folder_id }.merge(options))
end
create_file(folder_id, title) click to toggle source
# File lib/teamlab/modules/files.rb, line 35
def create_file(folder_id, title)
  @request.post([folder_id.to_s, 'file'], title: title.to_s)
end
create_html(folder_id, title, content) click to toggle source
# File lib/teamlab/modules/files.rb, line 31
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 23
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 15
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 27
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 19
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) click to toggle source

region File Creation

# File lib/teamlab/modules/files.rb, line 11
def create_txt_in_my_docs(title, content)
  @request.post(%w[@my text], title: title.to_s, content: content.to_s)
end
delete(options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 64
def delete(options = {})
  @request.put(%w[fileops delete], options)
end
delete_file(file_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 108
def delete_file(file_id)
  @request.delete(['file', file_id.to_s])
end
delete_folder(folder_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 157
def delete_folder(folder_id)
  @request.delete(['folder', folder_id.to_s])
end
document_server_info() click to toggle source
# File lib/teamlab/modules/files.rb, line 248
def document_server_info
  @request.get(%w[docservice])
end
finish_all() click to toggle source
# File lib/teamlab/modules/files.rb, line 68
def finish_all
  @request.put(%w[fileops terminate])
end
finish_operations(options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 80
def finish_operations(options = {})
  @request.put(%w[fileops bulkdownload], options)
end
get_common_docs(params = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 129
def get_common_docs(params = {})
  @request.get(['@common'], params)
end
get_file_history(file_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 96
def get_file_history(file_id)
  @request.get(['file', file_id.to_s, 'history'])
end
get_file_info(file_id) click to toggle source

region Files

# File lib/teamlab/modules/files.rb, line 92
def get_file_info(file_id)
  @request.get(['file', file_id.to_s])
end
get_file_operations_list() click to toggle source

region File operations

# File lib/teamlab/modules/files.rb, line 43
def get_file_operations_list
  @request.get(%w[fileops])
end
get_file_sharing(file_id) click to toggle source

region Sharing

# File lib/teamlab/modules/files.rb, line 165
def get_file_sharing(file_id)
  @request.get(['file', file_id.to_s, 'share'])
end
get_folder(folder_id, options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 137
def get_folder(folder_id, options = {})
  @request.get([folder_id.to_s], options)
end
get_folder_info(folder_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 141
def get_folder_info(folder_id)
  @request.get(['folder', folder_id.to_s])
end
get_folder_path(folder_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 145
def get_folder_path(folder_id)
  @request.get(['folder', folder_id.to_s, 'path'])
end
get_folder_sharing(folder_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 169
def get_folder_sharing(folder_id)
  @request.get(['folder', folder_id.to_s, 'share'])
end
get_my_docs(params = {}) click to toggle source

region Folders

# File lib/teamlab/modules/files.rb, line 116
def get_my_docs(params = {})
  @request.get(['@my'], params)
end
Also aliased as: get_my_files
get_my_files(params = {})
Alias for: get_my_docs
get_projects_folder(params = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 133
def get_projects_folder(params = {})
  @request.get(['@projects'], params)
end
get_shared_docs(params = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 121
def get_shared_docs(params = {})
  @request.get(['@share'], params)
end
get_third_party() click to toggle source

region Third-Party Integration

# File lib/teamlab/modules/files.rb, line 189
def get_third_party
  @request.get(%w[thirdparty])
end
get_trash(params = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 125
def get_trash(params = {})
  @request.get(['@trash'], params)
end
insert_file(folder_id, file, title: File.basename(file), keep_convert_status: false) click to toggle source
# File lib/teamlab/modules/files.rb, line 230
def insert_file(folder_id, file, title: File.basename(file), keep_convert_status: false)
  @request.post([folder_id.to_s, 'insert'], file: File.new(file), title: title, keepConvertStatus: keep_convert_status)
end
insert_to_common_docs(file, title: File.basename(file), keep_convert_status: false) click to toggle source
# File lib/teamlab/modules/files.rb, line 222
def insert_to_common_docs(file, title: File.basename(file), keep_convert_status: false)
  @request.post(%w[@common insert], file: File.new(file), title: title, keepConvertStatus: keep_convert_status)
end
insert_to_my_docs(file, title: File.basename(file), keep_convert_status: false, create_new_if_exists: nil) click to toggle source

@param create_new_if_exists [Boolean] create new file if same name file already exists

# File lib/teamlab/modules/files.rb, line 210
def insert_to_my_docs(file, title: File.basename(file), keep_convert_status: false, create_new_if_exists: nil)
  @request.post(%w[@my insert],
                file: File.new(file),
                title: title,
                keepConvertStatus: keep_convert_status,
                createNewIfExist: create_new_if_exists)
end
mark_as_read() click to toggle source
# File lib/teamlab/modules/files.rb, line 72
def mark_as_read
  @request.put(%w[fileops markasread])
end
move_files(dest_folder_id, options = {})
Alias for: move_to_folder
move_to_folder(dest_folder_id, options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 55
def move_to_folder(dest_folder_id, options = {})
  @request.put(%w[fileops move], { destFolderId: dest_folder_id }.merge(options))
end
Also aliased as: move_files
new_folder(folder_id, title) click to toggle source
# File lib/teamlab/modules/files.rb, line 149
def new_folder(folder_id, title)
  @request.post(['folder', folder_id.to_s], title: title)
end
remove_third_party_account(provider_id) click to toggle source
# File lib/teamlab/modules/files.rb, line 197
def remove_third_party_account(provider_id)
  @request.delete(['thirdparty', provider_id.to_s])
end
removes_sharing_rights(options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 181
def removes_sharing_rights(options = {})
  @request.delete(['share'], options)
end
rename_folder(folder_id, title) click to toggle source
# File lib/teamlab/modules/files.rb, line 153
def rename_folder(folder_id, title)
  @request.put(['folder', folder_id.to_s], title: title)
end
save_third_party(options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 193
def save_third_party(options = {})
  @request.post(%w[thirdparty], options)
end
share_file(file_id, user_id, access_type, options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 173
def share_file(file_id, user_id, access_type, options = {})
  @request.put(['file', file_id.to_s, 'share'], { share: { shareTo: user_id, Access: access_type } }.merge(options))
end
share_folder(folder_id, user_id, access_type, options = {}) click to toggle source
# File lib/teamlab/modules/files.rb, line 177
def share_folder(folder_id, user_id, access_type, options = {})
  @request.put(['folder', folder_id.to_s, 'share'], { share: { shareTo: user_id, Access: access_type } }.merge(options))
end
start_conversion(file_id, start) click to toggle source
# File lib/teamlab/modules/files.rb, line 84
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 100
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 104
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) click to toggle source
# File lib/teamlab/modules/files.rb, line 218
def upload_to_common_docs(file)
  @request.post(%w[@common upload], somefile: File.new(file))
end
upload_to_folder(folder_id, file) click to toggle source
# File lib/teamlab/modules/files.rb, line 226
def upload_to_folder(folder_id, file)
  @request.post([folder_id.to_s, 'upload'], somefile: File.new(file))
end
upload_to_my_docs(file) click to toggle source

region Uploads

# File lib/teamlab/modules/files.rb, line 205
def upload_to_my_docs(file)
  @request.post(%w[@my upload], somefile: File.new(file))
end